DeleteJob
Deletes scheduled, completed, cancelled, or failed jobs. If an instance of a scheduled report is running when the request is submitted, an exception is thrown.
To delete a single job, specify Id. To delete several jobs, specify IdList. To delete jobs that match the specified conditions, specify Search.
Request schema
<xsd:complexType name="DeleteJob">
<xsd:sequence>
<xsd:choice>
<xsd:element name="Search" type="typens:JobSearch"/>
<xsd:element name="IdList" type="typens:ArrayOfString"/>
<xsd:element name="Id" type="xsd:string"/>
</xsd:choice>
<xsd:element name="IgnoreMissing" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IgnoreActiveJob" type="xsd:boolean"
default=”false” minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
Search
The search conditions. If conditions apply to multiple fields, use ConditionArray.
IdList
The list of job IDs to delete.
Id
The ID of the single job to delete.
IgnoreMissing
Specifies what to do if the specified job does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.
IgnoreActiveJob
Flag indicating whether to delete a job if it is active.