Actuate Information Delivery API operations : SelectJobSchedules
 
SelectJobSchedules
Selects all scheduled jobs matching the specified criteria. SelectJobSchedules also retrieves information for expired and cancelled jobs.
In Release 11 or iHub, use SelectJobSchedules to obtain job schedule information. In Release 10 Service Pack 1 and earlier, use SelectJobs with JobCondition, specifying Scheduled, Expired, or Cancelled, to obtain designated job schedule information.
Release 11 Service Pack 4 and iHub support backward compatibility for all pre-Release 11 applications that send a SelectJobs request. However, all Release 11 and iHub applications must implement the new SelectJobSchedules API to request schedule information.
Request schema
<xsd:complexType name="SelectJobSchedules">
<xsd:sequence>
<xsd:element name="ResultDef" type="typens:ArrayOfString">
</xsd:element>
<xsd:choice>
<xsd:element name="Search"
type="typens:ScheduledJobSearch"/>
<xsd:element name="IdList" type="typens:ArrayOfString"/>
<xsd:element name="Id" type="xsd:string"/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
Request elements
ResultDef
The properties to retrieve.
Search
The search conditions. If conditions apply to multiple fields, use ConditionArray.
IdList
The list of job IDs to search.
Id
The ID of a single job to search.
Response schema
<xsd:complexType name="SelectJobSchedulesResponse">
<xsd:sequence>
<xsd:element name="Jobs" type="typens:ArrayOfJobProperties"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="TotalCount" type="xsd:long"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
Jobs
The selected jobs.
FetchHandle
Indicates that the number of items in the result set exceeds the FetchSize limit.
TotalCount
The number of entries in the search result set.