Reports
Post packages to generate documents and retrieve the generated documents.
| API | Description |
|---|---|
| POST v2/document |
Post a template and datasources to start the generation of a document. The generation is async so this request returns immediately. |
| GET v2/document/{guid} |
Returns the completed generated document, if it is complete. |
| GET v2/document/{guid}/file |
No documentation available. |
| GET v2/document/{guid}/meta |
No documentation available. |
| DELETE v2/document/{guid} |
Deletes the completed generated document. You should call this after retrieving a generated document. This call is synchronous but the deletion is asynchronous. So it returns immediately and the deletion should happen within a second. |
| GET v2/document/{guid}/status |
Returns the status of a document generation. The difference from v2/document/{guid} is that this call doesn't return the document itself. Note: v2 returns 302 when done while v1 returns 200. |
Template
| API | Description |
|---|---|
| POST v2/templates |
No documentation available. |
| GET v2/templates/{template_ID} |
No documentation available. |
| DELETE v2/templates/{template_ID} |
No documentation available. |
TagTree
Retrieve information from a template.
| API | Description |
|---|---|
| POST v2/tagtree |
Get an XML file of the tags in the submitted template. |
| GET v2/tagtree/{guid} |
Returns the completed tagtree, if it is complete. |
| GET v2/tagtree/{guid}/status |
Returns the status of a tagtree generation. The difference from v2/tagtree/{guid} is that this call doesn't return the tagtree itself. |
| DELETE v2/tagtree/{guid} |
Deletes the completed generated tagtree. You should call this after retrieving a generated tagtree. This call is synchronous but the deletion is asynchronous. So it returns immediately and the deletion should happen within a second. |
Metrics
Retrieve information from a template.
| API | Description |
|---|---|
| POST v2/metrics |
Get the metrics of the submitted template. |
| GET v2/metrics/{guid} |
Returns the completed metrics, if it is complete. |
| GET v2/metrics/{guid}/status |
Returns the status of a metrics generation. The difference from v2/metrics/{guid} is that this call doesn't return the metrics itself. |
| DELETE v2/metrics/{guid} |
Deletes the completed generated metrics. You should call this after retrieving a generated metrics. This call is synchronous but the deletion is asynchronous. So it returns immediately and the deletion should happen within a second. |
Version
Retrieve the version information of the Windward engines.
| API | Description |
|---|---|
| GET v2/version |
Get the version numbers of the RESTful service and the underlying reporting engine. |