Adding a Schedule

Adds a new schedule to a Web Intelligence document.

A schedule can be run now, once, daily, hourly, weekly, or monthly. A schedule can be triggered by a prompt. You can also select a server group that the system uses to run the schedule.

Note You can find scheduling information in the document details retrieved from the call GET <webiURL>/documents/{documentId}. The <scheduled> element returned in the response body provides true if the document has been scheduled, otherwise false.
Request

POST <webiURL>/documents/{documentId}/schedules

Where:

  • {documentId} is the document identifier retrieved from the list of documents

Request body:

<schedule>
    <name>
    <format type="webi|pdf|xls|csv"/>
    <destination>
    recurrence_expression
    <parameters>
    <serverGroup id="integer" required="true|false"/>
</schedule>

See Schedule XML Grammar for a description of the request body.

Response

Response type: application/xml or application/json

The response is a message stating the success or failure of a request.