Cancelling a request for a synchronous report
CancelReport supports cancelling a request for a synchronous report. Any user who can send a request for a report can cancel their own request. Only a system administrator can cancel the request of another user.
CancelReport returns one of the following status messages:
Failed, meaning that the cancellation request failed because of authentication issues or another cause
Succeeded, meaning that the request is cancelled
InActive, meaning that report generation was complete when BIRT iHub received the request
A report user can cancel a request for a synchronous report at two stages:
After submitting the synchronous job request and receiving a ConnectionHandle
After receiving the first page of a progressive report
The report user cannot cancel a request until the response to ExecuteReport returns a ConnectionHandle.
The following example shows how to cancel a request for synchronous report generation using the ConnectionHandle from the ExecuteReport request and identifying the report to cancel by ObjectId. ObjectId comes from the response to ExecuteReport. AuthId must the AuthId of the user who generated the report or the system administrator.
<SOAP-ENV:Header>
<AuthId>Ft7m4truCmY7k5EQLSkwhYEHEfic1c6pcWhvcxA==</AuthId>
<Locale>en_us</Locale>
<ConnectionHandle>RYEMWxKxEsxq0mQCiXCZHB8NiLDFwq1Q=
</ConnectionHandle>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CancelReport>
<ObjectId>435</ObjectId>
</CancelReport>
</SOAP-ENV:Body>
The preceding request returns the status of the cancellation.
<SOAP-ENV:Body>
<CancelReportResponse>
<Status>Succeeded</Status>
<CancelReportResponse>
</SOAP-ENV:Body>