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.
Since Product Version: 1.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/reportService/templates
Request Parameters
reportCategory
String
|
query
|
Optional
An optional filter to specify the report category
|
reportType
String
|
query
|
Optional
An optional filter to specify the report type
|
scheduled
String
|
query
|
Optional
An optional filter to specify whether the schedule status is Enabled, Expired, or Disabled
|
virtualDomain
String
|
query
|
Optional
An optional filter to specify the virtual domain name
|
Response Parameters
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://10.64.80.159/webacs/api/v1/op/reportService/templates
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v1/op">
<savedReportTemplateDTO>
<reportTitle>String value</reportTitle>
<reportType>String value</reportType>
<scheduled>String value</scheduled>
<virtualDomain>String value</virtualDomain>
</savedReportTemplateDTO>
<savedReportTemplateDTO>
<reportTitle>Another string value</reportTitle>
<reportType>Another string value</reportType>
<scheduled>Another string value</scheduled>
<virtualDomain>Another string value</virtualDomain>
</savedReportTemplateDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v1/op/reportService/templates.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/op\/reportService\/templates",
"@rootUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/op",
"savedReportTemplateDTO" : [{
"reportTitle" : "String value",
"reportType" : "String value",
"scheduled" : "String value",
"virtualDomain" : "String value"
},
{
"reportTitle" : "Another string value",
"reportType" : "Another string value",
"scheduled" : "Another string value",
"virtualDomain" : "Another string value"
}]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/reportService/templates
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
reportCategory
String
|
query
|
Optional
An optional filter to specify the report category
|
reportType
String
|
query
|
Optional
An optional filter to specify the report type
|
scheduled
String
|
query
|
Optional
An optional filter to specify whether the schedule status is Enabled, Expired, or Disabled
|
virtualDomain
String
|
query
|
Optional
An optional filter to specify the virtual domain name
|
Response Parameters
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://10.64.80.159/webacs/api/v2/op/reportService/templates
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v2/op">
<savedReportTemplateDTO>
<reportTitle>String value</reportTitle>
<reportType>String value</reportType>
<scheduled>String value</scheduled>
<virtualDomain>String value</virtualDomain>
</savedReportTemplateDTO>
<savedReportTemplateDTO>
<reportTitle>Another string value</reportTitle>
<reportType>Another string value</reportType>
<scheduled>Another string value</scheduled>
<virtualDomain>Another string value</virtualDomain>
</savedReportTemplateDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v2/op/reportService/templates.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v2/op",
"savedReportTemplateDTO" : [ {
"reportTitle" : "String value",
"reportType" : "String value",
"scheduled" : "String value",
"virtualDomain" : "String value"
}, {
"reportTitle" : "Another string value",
"reportType" : "Another string value",
"scheduled" : "Another string value",
"virtualDomain" : "Another string value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/reportService/templates
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
reportCategory
String
|
query
|
Optional
An optional filter to specify the report category
|
reportType
String
|
query
|
Optional
An optional filter to specify the report type
|
scheduled
String
|
query
|
Optional
An optional filter to specify whether the schedule status is Enabled, Expired, or Disabled
|
virtualDomain
String
|
query
|
Optional
An optional filter to specify the virtual domain name
|
Response Parameters
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://10.64.80.159/webacs/api/v3/op/reportService/templates
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v3/op">
<savedReportTemplateDTO>
<reportTitle>String value</reportTitle>
<reportType>String value</reportType>
<scheduled>String value</scheduled>
<virtualDomain>String value</virtualDomain>
</savedReportTemplateDTO>
<savedReportTemplateDTO>
<reportTitle>Another string value</reportTitle>
<reportType>Another string value</reportType>
<scheduled>Another string value</scheduled>
<virtualDomain>Another string value</virtualDomain>
</savedReportTemplateDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v3/op/reportService/templates.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v3/op",
"savedReportTemplateDTO" : [ {
"reportTitle" : "String value",
"reportType" : "String value",
"scheduled" : "String value",
"virtualDomain" : "String value"
}, {
"reportTitle" : "Another string value",
"reportType" : "Another string value",
"scheduled" : "Another string value",
"virtualDomain" : "Another string value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/reportService/templates
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
reportCategory
String
|
query
|
Optional
An optional filter to specify the report category
|
reportType
String
|
query
|
Optional
An optional filter to specify the report type
|
scheduled
String
|
query
|
Optional
An optional filter to specify whether the schedule status is Enabled, Expired, or Disabled
|
virtualDomain
String
|
query
|
Optional
An optional filter to specify the virtual domain name
|
Response Parameters
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://10.64.80.159/webacs/api/v4/op/reportService/templates
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v4/op">
<savedReportTemplateDTO>
<reportTitle>String value</reportTitle>
<reportType>String value</reportType>
<scheduled>String value</scheduled>
<virtualDomain>String value</virtualDomain>
</savedReportTemplateDTO>
<savedReportTemplateDTO>
<reportTitle>Another string value</reportTitle>
<reportType>Another string value</reportType>
<scheduled>Another string value</scheduled>
<virtualDomain>Another string value</virtualDomain>
</savedReportTemplateDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v4/op/reportService/templates.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v4/op",
"savedReportTemplateDTO" : [ {
"reportTitle" : "String value",
"reportType" : "String value",
"scheduled" : "String value",
"virtualDomain" : "String value"
}, {
"reportTitle" : "Another string value",
"reportType" : "Another string value",
"scheduled" : "Another string value",
"virtualDomain" : "Another string value"
} ]
}
}