Getting the List of Schedules

Gets the list of existing schedules for a Web Intelligence document.

Note You can find scheduling information in the details of a document. The <scheduled> element returned in the response body provides true if the document has been scheduled, otherwise false.
Request

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

Where:

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

Response type: application/xml or application/json

Response body: the list of schedules for the document, with the following information:

  • id
  • name
  • format (Webi, Pdf, Xls, or Csv)
  • status (Pending, Running, Paused, Completed, or Failed)

Example

<schedules>
    <schedule>
        <id>28600</id>
        <name>instanceWebi2Inbox</name>
        <format>Webi</format>
        <status>Completed</status>
    </schedule>
    <schedule>
        <id>28609</id>
        <name>instancePDF</name>
        <format>Pdf</format>
        <status>Completed</status>
    </schedule>
    <schedule>
        <id>28651</id>
        <name>instanceWebi2Inbox</name>
        <format>Webi</format>
        <status>Completed</status>
    </schedule>
    <schedule>
        <id>28810</id>
        <name>instanceWebI</name>
        <format>Webi</format>
        <status>Completed</status>
    </schedule>
</schedules>