This URL is used to get all the saved report templates. It returns an array of information about the available saved report templates.
Report templates need to be set up in the GUI to be available here.
Resource URL
/webacs/api/v1/op/reportService/templates
Request Parameters
String
|
reportCategory
optional
|
An optional filter to specify the report category
|
String
|
reportType
optional
|
An optional filter to specify the report type
|
String
|
scheduled
optional
|
An optional filter to specify whether the schedule status is Enabled, Expired, or Disabled
|
String
|
virtualDomain
optional
|
An optional filter to specify the virtual domain name
|
Response Parameters
String
|
reportTitle
|
The title of the saved report template
|
String
|
reportType
|
This describes the type of the report represented by the report template. Examples include: Inventory, Device Health, Interface Summary, etc.
|
String
|
scheduled
|
This field specifies if the saved report template's associated job schedule is Enabled, Disabled, or Expired.
|
String
|
virtualDomain
|
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://172.19.31.161/webacs/api/v1/op/reportService/templates
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://172.19.31.161/webacs/api/v1/op/reportService/reportService/templates" requestUrl="https://172.19.31.161/webacs/api/v1/op/reportService/templates" responseType="operation">
<savedReportTemplateDTO>
<reportTitle>String value</reportTitle>
<reportType>String value</reportType>
<scheduled>String value</scheduled>
<virtualDomain>String value</virtualDomain>
</savedReportTemplateDTO>
</mgmtResponse>
Sample JSON Response Payload
https://172.19.31.161/webacs/api/v1/op/reportService/templates.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/op\/reportService\/reportService\/templates",
"@requestUrl" : "https : \/\/172.19.31.161\/webacs\/api\/v1\/op\/reportService\/templates",
"@responseType" : "operation",
"savedReportTemplateDTO" : {
"reportTitle" : "String value",
"reportType" : "String value",
"scheduled" : "String value",
"virtualDomain" : "String value"
}
}
}