pp108 : GetScheduleByName

GetScheduleByName


This method is used to retrieve a schedule based on its name. GetScheduleByName is a part of the Methodset Scheduler 1.0 in the Cordys Scheduler application package.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetScheduleByName xmlns="http://schemas.cordys.com/scheduler/1.0">
            <name>SampleHourly</name>
        </GetScheduleByName>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

name

Name of the schedule model or schedule. It is possible to have a schedule without a schedule model.

Yes

String

SOAP Response

<data>
    <GetScheduleByNameResponse xmlns="http://schemas.cordys.com/scheduler/1.0">
        <tuple>
            <old>
                <schedule count="1" templateid="949D1910-1FD0-4535-AE20-5DDC53DB458A">
                    <scheduleid>3A278AF0-76B2-4A67-AEE7-029162353F23</scheduleid>
                    <name>SampleHourly</name>
                    <organizationalcontext>o=system,cn=cordys,o=test.com</organizationalcontext>
                    <datetime>
                        <hourly>
                            <minutes>0</minutes>
                        </hourly>
                        <starttime>2007-03-02 11:30:00</starttime>
                        <endtime>2007-03-02 11:45:00</endtime>
                    </datetime>
                    <scheduleat>2007-03-02 11:30:00</scheduleat>
                    <listener>cn=Northwind Service,cn=soap nodes,o=system,cn=cordys,o=org.com</listener>
                    <parameters>
                        <GetEmployee xmlns="http://schemas.cordys.com/1.0/demo/northwind">
                            <EmployeeID>101</EmployeeID>
                        </GetEmployee>
                    </parameters>
                    <owner>cn=Jdoe,cn=organizational users,o=system,cn=cordys,o=org.com</owner>
                </schedule>
            </old>
        </tuple>
    </GetScheduleByNameResponse>
</data>
Response Parameters

Parameter

Description

count

Number of times the schedule instance will be executed:

  • A positive value indicates the number of times the instance will be executed.
  • A value of '-1' indicates that the schedule instance will execute infinitely based on the defined conditions such as a specified duration.

templateid

ID of the schedule model

name

Name of the schedule

organizationalcontext

Organization in which the schedule is set to run

datetime

Details of the schedule types as defined in the schedule model. For example, daily, hourly, and so on. If the model is defined only for manual execution, then the value will be 'runnow'.

scheduleat

Date and time when the schedule will run next

listener(deprecated)

DN of the service container, which must participate when the schedule is executed at the specified time. The value of the listener is based on the actions defined in the schedule model.

Do not depend on the value of the listener as it is deprecated.

parameters

SOAP request that will be considered for triggering the action at the scheduled time.

owner

User who instantiated the schedule. If the 'auto-deploy' is on, then the user will be the same as the user who deployed the model. If the 'auto-deploy' is off, then it will be the user who activated the schedule.