Report templates need to be set up in the GUI to be available here.
Since Product Version: 1.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v2/op/reportService/templates UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
reportCategory String |
query |
OptionalAn optional filter to specify the report category |
reportType String |
query |
OptionalAn optional filter to specify the report type |
scheduled String |
query |
OptionalAn optional filter to specify whether the schedule status is Enabled, Expired, or Disabled |
virtualDomain String |
query |
OptionalAn optional filter to specify the virtual domain name |
Response Parameters
Attribute | Description |
---|---|
reportTitle String |
The title of the saved report template |
reportType String |
This describes the type of the report represented by the report template. Examples include: Inventory, Device Health, Interface Summary, etc. |
scheduled String |
This field specifies if the saved report template's associated job schedule is Enabled, Disabled, or Expired. |
virtualDomain String |
The field specifies the associated virtual domain name of the saved report template. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/reportService/templates
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/reportService/templates" rootUrl="https://localhost/webacs/api/v2/op">
<savedReportTemplateDTO>
<reportTitle>String value</reportTitle>
<reportType>String value</reportType>
<scheduled>String value</scheduled>
<virtualDomain>String value</virtualDomain>
</savedReportTemplateDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/reportService/templates.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/reportService/templates",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"savedReportTemplateDTO" : [ {
"reportTitle" : "String value",
"reportType" : "String value",
"scheduled" : "String value",
"virtualDomain" : "String value"
} ]
}
}