Retrieving a Schedule

This RESTful web service request can be used to retrieve an existing ReportCaster Schedule.

HTTP Method: GET

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ScheduleNameIBIRS_action=get

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder used for the stored ReportCaster Schedule. If the folder used for the stored ReportCaster Schedule exists as a subfolder, then the path to the subfolder name must be included in the REST URL. For example, TopFolderName/SubFolderName.

ScheduleName

Is the name of the ReportCaster Schedule to retrieve, which also must have a .sch extension.

Example:

In the following example, a schedule called REST_Schedule.sch is retrieved from the Car_Reports folder, which is within the RESTful_Web_Services folder.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/
Car_Reports/REST_Schedule.sch?IBIRS_action=get

Response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="get" returncode="10000" returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
  <ibfsparams size="2">
    <entry key="IBIRS_args" value="__null"/>
    <entry key="IBIRS_" value="/WFC/Repository/RESTful_Web_Services/Car_Reports/REST_Schedule.sch"/>
  </ibfsparams>
  <rootObject _jt="IBFSCasterObject" binary="false" createdOn="1356718595487" defaultLng="en_US" description="Schedule Created through REST"
        dummy="false" effectiveRSName="EDASERVE" extension="sch" externalId="S1995b2ecsa8f6s4096sa62es1867fa2d7a85"
fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports/REST_Schedule.sch" handle="7c2fd2a3I2dbcI400dIb666I3512e8d8b89f"
        lastModified="1356718595487" lastaccessBy="admin" lastaccessOn="1356719962891" length="0" name="REST_Schedule.sch" ownerId="10001"
        ownerName="admin" ownerType="U" policy="//3/D///9+P9////v/////////+AAAA=" returnedLng="en_US"
rsPath="/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/Car_Reports/REST_Schedule.sch" type="CasterSchedule">
    <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
      <entry>
        <key _jt="string" value="en_US"/>
        <value _jt="ArrayList" size="2">
          <item _jt="string" index="0" value="Schedule Created through REST"/>
        </value>
      </entry>
    </nlsValues>
    <properties size="2">
      <entry key="id" value="S1995b2ecsa8f6s4096sa62es1867fa2d7a85"/>
      <entry key="tool" value="schedule"/>
    </properties>
    <casterObject _jt="CasterSchedule" active="false" compressedReport="false" deleteJobAfterRun="false"
           description="Schedule Created through REST" destinationAddress="OWNER" ibfsId="7c2fd2a3I2dbcI400dIb666I3512e8d8b89f"
           ibfsPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports" id="S1995b2ecsa8f6s4096sa62es1867fa2d7a85"
           name="REST_Schedule.sch" nextRunTime="disabled" notification="INACTIVE" owner="admin"
           policy="open,delete,rename,|,run,|,security;makeRules;viewRules" priority="3" recurrence="0"
           scheduleId="S1995b2ecsa8f6s4096sa62es1867fa2d7a85" scheduleTitle="Schedule Created through REST" sendMethod="LIBRARY"
           statusLastExecuted="" taskType="1" traceType="0">
      <notification _jt="CasterScheduleNotification" 
addressForBriefNotification="" addressForFullNotification="" description=""
            from="" id="" subject="" type="INACTIVE"/>
   <distributionList _jt="array" itemsClass="CasterScheduleDistribution" size="1">
        <item accessList="" accessListFullPath="" accessType="OWNER" category="" class="ibi.broker.api.data.schedule.StorageLibrary"
              compressionEnabled="false" counter="0" description="Report Library"
              destinationIbfsId="c60b1f9a_05ef_4e72_a737_e869917607db" destinationPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports"
              disabled="false" expirationData="1" expirationMode="N" id="D58215579d4885d4b5eda023d9f44d1b4da01" index="0" type="LIBRARY"
              valueonly="false">
          <storageLibraryEmail authEnabled="false" authPassword="" authUserId="" class="ibi.broker.api.data.schedule.StorageLibraryEmail"
                libraryURL="http://localhost:8080/ibi_apps/library/report.rc" mailFrom="" mailMessage="" mailReplyAddress=""
                mailServerName="ibismtp.ibi.com" mailSubject="" sendEmailAfterSaveReport="false" sslEnabled="false" tlsEnabled="false"/>
        </item>
      </distributionList>
      <timeInfoList _jt="array" itemsClass="CasterScheduleTimeInfo" size="1">
        <item class="ibi.broker.api.data.schedule.TimeInfoOnce" description="" disabled="false" id="Ifc777178i1ab0i42faibd06i81df82c234e7"
              index="0" name="" type="0">
   <nextRunTime _jt="calendar" time="1355756400000" timeZone="America/New_York"/>
   <startTime _jt="calendar" time="1355756400000" timeZone="America/New_York"/>
        </item>
      </timeInfoList>
      <taskList _jt="array" itemsClass="CasterScheduleTask" size="1">
        <item alertEnabled="false" burst="true" class="ibi.broker.api.data.schedule.TaskStandardReport" description="Task 1" disabled="false"
              domainHREF="" execId="guest" execPassword="" firstPostProcessingProcedure="" firstPreProcessingProcedure="" folderHREF=""
              id="Tcdde20bdt3305t436ata200tecd3367ad16f" index="0" procedureDescription=""
              procedureId="64e971c8_fd80_4d07_99a7_a2356743010b"
              procedureName="IBFS:/WFC/Repository/RESTful_Web_Services/
Car_Reports/Sales_Report_by_Country.fex" reportName="car_sales.htm"
              secondPostProcessingProcedure="" secondPreProcessingProcedure="" sendFormat="HTML" serverName="EDASERVE" type="1">
          <parameterList _jt="array" itemsClass="CasterScheduleParameter" size="2">
            <item _jt="CasterScheduleParameter" index="0" name="COUNTRY" type="0" useDefaultValue="false" value="ENGLAND"/>
            <item _jt="CasterScheduleParameter" index="1" name="DEALER_COST" type="0" useDefaultValue="false" value="10000"/>
          </parameterList>
        </item>
      </taskList>
      <lastTimeExecuted _jt="calendar" time="18000000" timeZone="America/New_York"/>
    </casterObject>
  </rootObject>
</ibfsrpc>

Information Builders