1.0.1 Example Request and Operation Result¶

This is the full SOAP request for a scheduleJob operation that creates a job with four report parameters:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope>
  <soapenv:Body>
  <ns1:scheduleJob soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/
      " xmlns:ns1="http://www.jasperforge.org/jasperserver/ws">
      <job xsi:type="ns1:Job">
        <reportUnitURI xsi:type="xsd:string">/reports/samples/SalesByMonth
        </reportUnitURI>
        <username xsi:type="xsd:string" xsi:nil="true"/>
        <label xsi:type="xsd:string">Label 3</label>
        <description xsi:type="xsd:string">Description 3</description>
        <simpleTrigger xsi:type="ns1:JobSimpleTrigger">
          <timezone xsi:type="xsd:string" xsi:nil="true"/>
          <startDate xsi:type="xsd:dateTime">2008-10-09T09:25:00.000Z</startDate>
          <endDate xsi:type="xsd:dateTime" xsi:nil="true"/>
          <occurrenceCount xsi:type="xsd:int">1</occurrenceCount>
          <recurrenceInterval xsi:type="xsd:int" xsi:nil="true"/>
          <recurrenceIntervalUnit xsi:type="ns1:IntervalUnit" xsi:nil="true"/>
        </simpleTrigger>
        <calendarTrigger xsi:type="ns1:JobCalendarTrigger" xsi:nil="true"/>
        <parameters soapenc:arrayType="ns1:JobParameter[4]" xsi:type="soapenc:Array">
          <parameters xsi:type="ns1:JobParameter">
            <name xsi:type="xsd:string">TextInput</name>
            <value xsi:type="soapenc:int">22</value>
          </parameters>
          <parameters xsi:type="ns1:JobParameter">
            <name xsi:type="xsd:string">CheckboxInput</name>
            <value xsi:type="soapenc:boolean">true</value>
          </parameters>
          <parameters xsi:type="ns1:JobParameter">
            <name xsi:type="xsd:string">ListInput</name>
            <value xsi:type="soapenc:string">2</value>
          </parameters>
          <parameters xsi:type="ns1:JobParameter">
            <name xsi:type="xsd:string">DateInput</name>
            <value xsi:type="xsd:dateTime">2007-10-09T09:00:00.000Z</value>
          </parameters>
        </parameters>
        <baseOutputFilename xsi:type="xsd:string">Sales3</baseOutputFilename>
        <outputFormats soapenc:arrayType="xsd:string[1]" xsi:type=
          "soapenc:Array">
          <outputFormats xsi:type="xsd:string">PDF</outputFormats>
        </outputFormats>
        <outputLocale xsi:type="xsd:string" xsi:nil="true"/>

        <repositoryDestination xsi:type="ns1:JobRepositoryDestination">
          <folderURI xsi:type="xsd:string">/ContentFiles</folderURI>
          <sequentialFilenames xsi:type="xsd:boolean">false
          </sequentialFilenames>
          <overwriteFiles xsi:type="xsd:boolean">false</overwriteFiles>
        </repositoryDestination>
        <mailNotification xsi:type="ns1:JobMailNotification" xsi:nil="true"/>
      </job>
    </ns1:scheduleJob>
  </soapenv:Body>
</soapenv:Envelope>

The response of the request contains the job details as saved by the server:

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope>
  <soapenv:Body>
    <ns1:scheduleJobResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/
      encoding/" xmlns:ns1="http://www.jasperforge.org/jasperserver/ws">
      <scheduleJobReturn xsi:type="ns1:job">
        <id xsi:type="xsd:long">7</id>
        <version xsi:type="xsd:int">0</version>
        <reportUnitURI xsi:type="xsd:string">/reports/samples/SalesByMonth</
          reportUnitURI>
        <username xsi:type="xsd:string">tomcat</username>
        <label xsi:type="xsd:string">Label 3</label>
        <description xsi:type="xsd:string">Description 3</description>
        <simpleTrigger xsi:type="ns1:jobSimpleTrigger">
          <id xsi:type="xsd:long">7</id>
          <version xsi:type="xsd:int">0</version>
<timezone xsi:type="xsd:string">Europe/Minsk</timezone>
          <startDate xsi:type="xsd:dateTime">2008-10-09T09:25:00.000Z</startDate>
          <endDate xsi:type="xsd:dateTime" xsi:nil="true"/>
          <occurrenceCount xsi:type="xsd:int">1</occurrenceCount>
          <recurrenceInterval xsi:type="xsd:int" xsi:nil="true"/>
          <recurrenceIntervalUnit xsi:type="ns1:IntervalUnit" xsi:nil="true"/>
        </simpleTrigger>

<calendarTrigger xsi:type="ns1:JobCalendarTrigger" xsi:nil="true"/>

        <parameters soapenc:arrayType="ns1:JobParameter[4]" xsi:type="soapenc:Array">
          <parameters xsi:type="ns1:jobParameter">
            <name xsi:type="xsd:string">CheckboxInput</name>
            <value xsi:type="soapenc:boolean">true</value>
          </parameters>
          <parameters xsi:type="ns1:jobParameter">
            <name xsi:type="xsd:string">TextInput</name>
            <value xsi:type="soapenc:int">22</value>
          </parameters>

          <parameters xsi:type="ns1:jobParameter">
            <name xsi:type="xsd:string">DateInput</name>
            <value xsi:type="xsd:dateTime">2007-10-09T09:00:00.000Z</value>
          </parameters>
          <parameters xsi:type="ns1:jobParameter">
            <name xsi:type="xsd:string">ListInput</name>
            <value xsi:type="soapenc:string">2</value>
          </parameters>
        </parameters>
        <baseOutputFilename xsi:type="xsd:string">Sales3</baseOutputFilename>
        <outputFormats soapenc:arrayType="xsd:string[1]" xsi:type="soapenc:Array">
          <outputFormats xsi:type="xsd:string">PDF</outputFormats>
        </outputFormats>
          <outputLocale xsi:type="xsd:string" xsi:nil="true"/>
          <repositoryDestination xsi:type="ns1:jobRepositoryDestination">
            <id xsi:type="xsd:long">7</id>
            <version xsi:type="xsd:int">0</version>
            <folderURI xsi:type="xsd:string">/ContentFiles</folderURI>
            <sequentialFilenames xsi:type="xsd:boolean">false</sequentialFilenames>
            <overwriteFiles xsi:type="xsd:boolean">false</overwriteFiles>
          </repositoryDestination> 
        <mailNotification xsi:type="ns1:JobMailNotification" xsi:nil="true"/>
      </scheduleJobReturn>
    </ns1:scheduleJobResponse>
  </soapenv:Body>
</soapenv:Envelope>