The data structures of Yellowfin's schedule management web services consist of two main objects (which are abstract types): AdministrationSchedule and ScheduleFrequency. AdministrationSchedule describes common properties of all schedules, including a code for determining the object subtype and most importantly containing a ScheduleFrequency object. This ScheduleFrequency object holds common data for all frequency types and is the primary way of editing schedules. Both AdministrationSchedule and ScheduleFrequency have several concrete classes representing each type of schedule and frequency available in Yellowfin. These concrete classes contain user-friendly methods to access and manipulate type-specific schedule and frequency data with client-side validation, but this is only the case when using the Java bindings.
Most attributes of an AdministrationSchedule are not editable, except for the isActive attribute. Note that this only means that the attributes are ignored by the service backend, the beans themselves are still able to be edited.
This web service loads all available schedules in the current organization that is specified with the OrgId parameter.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service is used to load a specified schedule.
Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response will contain these parameters:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service saves a single schedule. It uses the AdministrationSchedule object to pass the details of the schedule that need to be saved. The response will return this object with the new details. Note, that this does not create a new schedule, but updates the details of an existing one.
Request ParametersThe following parameters should be passed with this request:
The following parameters must be included in the AdministrationSchedule object for this function:
For the Frequency object, exact required values are different for each ScheduleFrequency type, but all frequency types will contain the following fields:
Response ParametersThe returned response will contain these parameters:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service is used to delete a specified schedule.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service submits a schedule to run it.
Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response will contain these parameters:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service pauses a schedule. Here “pausing” a schedule refers to pausing it’s frequency schedule and does not affect the schedule if it is currently running or queued for running, but will stop it from being queued in the future. NOTE: This is a shorthand way of pausing the schedule. This can also be achieved by loading the schedule, updating it’s active state to false and then saving it.
Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response will contain these parameters:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service resumes a paused schedule. “Resuming” a schedule refers to resuming it’s frequency schedule and does not queue the item for running, but will allow it to be queued for running again upon its next scheduled date/time. NOTE: This is a shorthand way of resuming the schedule. This can also be achieved by loading the schedule, updating it’s active state to true and then saving it.
Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response will contain these parameters:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|