Table of Contents

Search

  1. Preface
  2. Overview, Downloading, and Installing
  3. Administration API
  4. Identity Service API
  5. Screenflow Programming and SDK
  6. ActiveVOS WSHT API
  7. Embedding Request Forms in Standalone Web Pages
  8. XML-JSON for Process Central

7. APIs, SDKs, and Services

7. APIs, SDKs, and Services

Scheduler API

Scheduler API

The Scheduler API lets you capture the following information:
  • Disabled
  • End Time
  • Last Execution Date
  • Last Process ID
  • Last Process State
  • Next Execution Date
  • Plan ID
  • Process Schedule
  • Schedule Date
  • Schedule Every
  • Schedule Frequency
  • Schedule Name
  • Schedule Restriction
  • Schedule Time
  • Service Name
  • Start Time
  • Trigger Info
The elements described in the following table are contained within an
<wsdl:portType name="IAeScheduleManagement">
element.
Operation Name
Operation
Description
createDatabaseMaintenanceSchedule
<wsdl:operation name="createDatabaseMaintenanceSchedule"> <wsdl:input message="tns:createDatabaseMaintenanceSchedule" /> <wsdl:output message="tns:createDatabaseMaintenanceScheduleeResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Creates a maintenance schedule for a database.
createSchedule
<wsdl:operation name="createSchedule"> <wsdl:input message="tns:CreateSchedule" /> <wsdl:output message="tns:CreateScheduleResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Creates a schedule.
deleteSchedule
<wsdl:operation name="deleteSchedule"> <wsdl:input message="tns:DeleteSchedule" /> <wsdl:output message="tns:DeleteScheduleResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Deletes a schedule.
editSchedule
<wsdl:operation name="editSchedule"> <wsdl:input message="tns:EditSchedule" /> <wsdl:output message="tns:EditScheduleResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Changes items within a schedule.
getAllSchedules
<wsdl:operation name="getAllSchedules"> <wsdl:input message="tns:GetAllSchedules" /> <wsdl:output message="tns:GetAllSchedulesResponse" /> </wsdl:operation>
Returns information on all schedules.
getDatabaseMaintenanceSchedule
<wsdl:operation name="getDatabaseMaintenanceSchedule"> <wsdl:input message="tns:getDatabaseMaintenanceSchedule" /> <wsdl:output message="tns:getDatabaseMaintenanceScheduleResponse" /> </wsdl:operation>
Returns information on the maintenance schedule for your databases.
runDatabaseMaintenance
<wsdl:operation name="runDatabaseMaintenance"> <wsdl:input message="tns:runDatabaseMaintenance" /> <wsdl:output message="tns:runDatabaseMaintenanceResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Initiates the maintenance for a database.
runNow
<wsdl:operation name="runNow"> <wsdl:input message="tns:RunNow" /> <wsdl:output message="tns:RunNowResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Tells a scheduled item that it should run now instead of at its scheduled time.
setScheduleStatus
<wsdl:operation name="setScheduleStatus"> <wsdl:input message="tns:SetScheduleStatus" /> <wsdl:output message="tns:SetScheduleStatusResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Sets the status for a schedule.