Windward RESTful Engine API Help

Introduction

The RESTful Engine API (application program interface) is used to interact with the RESTful Engine server installed in your network environment.

RESTful engine's API implementation.

API	Description
POST v1/reports	POST /v1/reports Post a template for the report generation.
GET v1/reports/{guid}	GET /v1/reports/{guid} Returns the previously generated report.
DELETE v1/reports/{guid}	DELETE /v1/reports/{guid} Deletes the previously generated report.
GET v1/reports/{guid}/status	GET v1/reports/{guid}/status Returns the status of a report generation. The difference from GET v1/reports/{guid} is that this call doesn't return the report itself.

Retrive metrics information of a template.

API	Description
POST v1/metrics	Get the metrics of a given template.

Retrieve the version information of the Windward engines.

API	Description
GET v1/version	Get the version numbers of the RESTful service and the underlying reporting engine.