SOAP API - checkAutoArchive

The table summarizes the SOAP API - checkAutoArchive.

Request Uses the checkAutoArchiveRequest element (from the EventCollectorManagementService schema).
Response Returns a checkAutoArchiveResponse element (from the EventCollectorManagementService schema).
Provides the following data about the archive:
  • isRunning: whether or not the archive is currently running.
  • status: if the archive is running, its status. For example, Starting archive, Archiving batch 10, Archiving system events, Completing archive.
  • nextArchiveAt: the time, in the format hh:mm, that the next archive will run.
  • lastRun: provides data about the last archive that run. See AutoArchiveResult.
  • currentRun: provides data about the archive that is currently running. See AutoArchiveResult.
Example Request: 
<soapenv:Body>
      <api:checkAutoArchiveRequest>
      </api:checkAutoArchiveRequest>
</soapenv:Body>
Response: 
 <SOAP-ENV:Body>
      <checkAutoArchiveResponse xmlns="http://api.ec.n2.tibco.com">
         <status xmlns="">
            <isRunning>false</isRunning>
            <status>No Archive running</status>
            <nextArchiveAt>2015-07-10T12:00:00.000Z</nextArchiveAt>
            <lastRun>
               <start>2015-07-09T12:00:00.004Z</start>
               <end>2015-07-09T12:00:00.394Z</end>
               <duration>390</duration>
               <instancesArchived>1</instancesArchived>
               <instanceEventsArchived>10</instanceEventsArchived>
               <systemEventsArchived>15</systemEventsArchived>
               <totalEventsArchived>25</totalEventsArchived>
               <ecEventSize>1839</ecEventSize>
               <succeeded>true</succeeded>
               <timeout>2015-07-09T14:00:00.000Z</timeout>
            </lastRun>
         </status>
      </checkAutoArchiveResponse>
 </SOAP-ENV:Body>