Page History

...

Purpose: DuraReport generates reports relating to the status of your DuraCloud instance, and provides a simple interface for accessing those reports.

Resources: XML schema which defines the expected transfer data for storage and service reporting can be found on the Downloads page

Panel

title	Initialization REST Methods

Initialize Application

Purpose: Allows the initialization of durareport
Request: POST https://host:port/durareport/reports

Request Body: XML similar to:

Code Block

	xml
	xml

<durareportConfig>
  <durastoreHost>[host]</durastoreHost>
  <durastorePort>[port]</durastorePort>
  <durastoreContext>durastore</durastoreContext>
  <duraserviceHost>[host]</duraserviceHost>
  <duraservicePort>[port]</duraservicePort>
  <duraserviceContext>duraservice</duraserviceContext>
</durareportConfig>

Response Code: 200 (on success)
Response Body: "Initialization Successful" (on success)

, defined by the storage report XSD

Get Storage Report List

Purpose: Provides a list of all storage report IDs
Request: GET https://host:port/durareport/storagereport/list
Response Code: 200 (on success)
Response Body: XML similar to:

, defined by the storage report XSD

Get Storage Report

Purpose: Provides a specific storage report based on the provided report ID
Request: GET https://host:port/durareport/storagereport/reportID
Response Code: 200 (on success)
Response Body: XML similar to:

, defined by the storage report XSD

Get Storage Report Info

Purpose: Provides a information about the current status of the storage reporting system
Request: GET https://host:port/durareport/storagereport/info
Response Code: 200 (on success)
Response Body: XML similar to:

, defined by the storage report XSD

Start Storage Report

Purpose: Starts a storage report if one is not already running
Request: POST https://host:port/durareport/storagereport
Response Code: 200 (on success)
Response Body: "Report Started" (on success), or ""Report Already In Progress" (if a report is already in progress)

Cancel Storage Report

Purpose: Cancels a running storage report
Request: DELETE https://host:port/durareport/storagereport
Response Code: 200 (on success)
Response Body: "Storage report cancelled"

Schedule Storage Report

Purpose: Schedules a time for a storage report to be run
Request: POST https://host:port/durareport/storagereport/schedule ? (startTime) (frequency)
- startTime: time (in milliseconds since the epoch) to begin the next storage report
- frequency: time (in milliseconds) to wait between running reports (minimum value is 600000)
Response Code: 200 (on success)
Response Body: "Storage reports scheduled" (on success)

Cancel Storage Report Schedule

Purpose: Cancels all entries on the storage report schedule
Request: DELETE https://host:port/durareport/storagereport/schedule
Response Code: 200 (on success)
Response Body: "Storage Reports schedule cancelled"

Panel

title	Storage Report REST Methods

Get Latest Storage Report

Purpose: Provides the most current storage report in XML format
Request: GET https://host:port/durareport/storagereport
Response Code: 200 (on success)
Response Body: XML similar to:

Code Block

xml

TBD

Code Block

xml

TBD

Code Block

xml

TBD

Code Block

xml

TBD

TBD , defined by the service report XSDs

Get Completed Services Report

Purpose: Provides a listing of the most recent completed services
Request: GET https://host:port/durareport/servicereport ? (limit)
- Parameter value for limit (optional) should indicate the maximum number of services to return in the report (default is 20, max is 1000)
Response Code: 200 (on success)
Response Body: XML similar to:

, defined by the service report XSDs

Get Completed Services Report List

Purpose: Provides a listing of all service report IDs
Request: GET https://host:port/durareport/servicereport/list
Response Code: 200 (on success)
Response Body: XML similar to:

, defined by the service report XSDs

Get Services Report

Purpose: Provides a specific services report based on the provided report ID
Request: GET https://host:port/durareport/servicereport/reportID
Response Code: 200 (on success)
Response Body: XML similar to:

TBD , defined by the service report XSDs

Panel

title	Service Report REST Methods

Get Deployed Services Report

Purpose: Provides a listing of the services which are currently deployed
Request: GET https://host:port/durareport/storagereport/deployed
Response Code: 200 (on success)
Response Body: XML similar to:

Code Block

xml

Code Block

xml

TBD

Code Block

xml

TBD

Code Block

xml

Page tree

Versions Compared

Old Version 16

New Version 17

Key

Initialize Application

Get Storage Report List

Get Storage Report

Get Storage Report Info

Start Storage Report

Cancel Storage Report

Schedule Storage Report

Cancel Storage Report Schedule

Get Latest Storage Report

Get Completed Services Report

Get Completed Services Report List

Get Services Report

Get Deployed Services Report