Getting the Details of a Schedule

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

Request

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

Where:

  • {documentId}: the identifier of the Web Intelligence document retrieved from the document list
  • {scheduleId}: the identifier of the schedule available for a document and retrieved from the schedule list
Response

Response type: application/xml or application/json

Response body: provides for the specified schedule: its id, name, format and status.

Example

GET <webiURL>/documents/8023/schedules/9439

<schedule>
    <id>9439</id>
    <name>GC-now-schedule</name>
    <format type="webi"/>
    <status>Completed</status>
</schedule>