Getting the Details of a Schedule

Usage

Gets the details of a schedule of a Web Intelligence document.

Request

GET /documents/<documentID>/schedules/<scheduleID>

Response

Response type: application/xml or application/json

Response body:

<schedule>
    <id>
    <name>
    <format type="webi|pdf|xls|csv">
    <status id="0|1|3|8|9">
    <destination>
    <error>
    recurrence_expression
    <serverGroup id="integer" required="Boolean"/>
    <parameters>
</schedule>

See Schedules for a description of the response body.

Example

GET /documents/8023/schedules/9439

<schedule>
    <id>9439</id>
    <name>now-schedule</name>
    <format type="webi"/>
    <status id="1">Completed</status>
    <destination>
        <ftp> 
            <host>vs0202</host>  
            <port>21</port>  
            <username>admin</username>  
            <account/>  
            <directory>./</directory> 
        </ftp> 
    </destination>
    <once retriesAllowed="0" retryIntervalInSeconds="1800">
        <startdate>2014-06-18T14:19:00.000+02:00</startdate>
        <enddate>2014-06-18T14:20:00.000+02:00</enddate>
    </once>
    <serverGroup id="0" required="false"/>
    <parameters>
        <parameter dpId="DP0">
            <id>1</id>
            <technicalName>Enter value(s) for Year</technicalName>
            <name>Enter value(s) for Year</name>
            <answer>
                <values>
                    <value>2005</value>
                </values>
            </answer>
        </parameter>
    </parameters>
</schedule>

In the case of a failure, the response contains an error message. It can be as follows:

<schedule> 
    <id>9439</id>  
    <name>now-schedule</name>  
    <format type="webi"/>  
    <status id="3">Failed</status>  
    <error> 
        <error_code>FWB 00031</error_code>  
        <message>Destination disabled. []: [CrystalEnterprise.Ftp]. Please note the name
            of the job server used for your request and contact your system administrator
            to make sure the specified destination is enabled. (FWB 00031)</message> 
    </error>  
    <destination> 
        <ftp>
            ...
        </ftp>
    </destination>
    ...
</schedule>