GetSyncJobInfo
Retrieves information about a synchronous job.
GetSyncJobInfo is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.
Request schema
<xsd:complexType name="GetSyncJobInfo">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="ObjectId" type="xsd:string">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Request elements
ObjectId
The ID of the synchronous job for which to retrieve information.
Response schema
<xsd:complexType name="GetSyncJobInfoResponse">
<xsd:sequence>
<xsd:element name="Status">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Pending"/>
<xsd:enumeration value="Running"/>
<xsd:enumeration value="Completed"/>
<xsd:enumeration value="Failed"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ErrorDescription" type="xsd:string"
minOccurs="0"/>
<xsd:element name="Pending" type="PendingSyncJob"
minOccurs="0"/>
<xsd:element name="Running" type="RunningJob" minOccurs="0"/
</xsd:sequence>
</xsd:complexType>
Response elements
Status
The status of the job. Valid values are:
Pending
Running
Completed
Failed
ErrorDescription
The description of the error. Returned if Status is Failed.
Pending
The properties of the pending synchronous job.
Running
The properties of the running synchronous job.