pp108 : GetScheduleById

GetScheduleById


This method is used to retrieve a schedule based on its ID. GetScheduleById 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>
        <GetScheduleById xmlns="http://schemas.cordys.com/scheduler/1.0">
            <scheduleid>00215A63-1B7C-11E2-EE1D-303E95409F4D</scheduleid>
        </GetScheduleById>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

scheduleid

ID of the required schedule. You can obtain the scheduleid by invoking any of the following SOAP APIs:

Yes

GUID

Note: If you run this method using the http://schemas.cordys.com/1.0/coboc namespace and if the schedules do not match, you will receive a SOAP fault. When this method is executed with the http://schemas.cordys.com/4.2/coboc namespace, and if the schedules do not match, you will receive an empty response.

As CoBOC APIs are deprecated, it is recommended to have the namespace corrected with the details as provided in this page.

SOAP Response

<data>
    <GetScheduleByIdResponse
        xmlns="http://schemas.cordys.com/scheduler/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <tuple xmlns="http://schemas.cordys.com/scheduler/1.0">
            <old>
                <schedule count="-1" templateid="00215A63-1B7C-11E2-EE1D-22208A01BF4D">
                    <scheduleid>00215A63-1B7C-11E2-EE1D-303E95409F4D</scheduleid>
                    <name>Test</name>
                    <organizationalcontext>o=system,cn=cordys,cn=build532,o=org.com</organizationalcontext>
                    <datetime>
                        <daily>
                            <time>14:0</time>
                        </daily>
                        <starttime>2013-02-07 11:15:02</starttime>
                        <endtime>-1</endtime>
                    </datetime>
                    <scheduleat>2013-02-07 14:00:00</scheduleat>
                    <listener>cn=Northwind Service,cn=soap nodes,o=system,cn=test,o=org.com</listener>
                    <parameters>
                        <GetEmployee xmlns="http://schemas.cordys.com/1.0/demo/northwind">
                            <EmployeeID>101</EmployeeID>
                        </GetEmployee>
                    </parameters>
                    <owner>cn=tester,cn=organizational users,o=system,cn=cordys,cn=test,o=org.com</owner>
                </schedule>
            </old>
        </tuple>
    </GetScheduleByIdResponse>
</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.