Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

...

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
xml
TBD

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:
Code Block
xml
xml
TBD

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:
Code Block
xml
xml
TBD

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:
Code Block
xml
xml
TBD

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)

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^{Image Added}
Response Code: 200 (on success)
Response Body: XML similar to:
Code Block
xml
xml
TBD

Get Completed Services Report

Purpose: Provides a listing of the most recent completed services
Request: GET https://host:port/durareport/servicereport^{Image Added} ? (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:
Code Block
xml
xml
TBD

Get Completed Services Report List

Purpose: Provides a listing of all service report IDs
Request: GET https://host:port/durareport/servicereport/list^{Image Added}
Response Code: 200 (on success)
Response Body: XML similar to:
Code Block
xml
xml
TBD

Get Services Report

Purpose: Provides a specific services report based on the provided report ID
Request: GET https://host:port/durareport/servicereport/reportID^{Image Added}
Response Code: 200 (on success)
Response Body: XML similar to:
Code Block
xml
xml
TBD