Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET reportService/templates

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

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 URL

/webacs/api/v1/op/reportService/templates

Request Parameters

Type Attribute Name Source Description

String

reportCategory optional

query

An optional filter to specify the report category

String

reportType optional

query

An optional filter to specify the report type

String

scheduled optional

query

An optional filter to specify whether the schedule status is Enabled, Expired, or Disabled

String

virtualDomain optional

query

An optional filter to specify the virtual domain name

Response Parameters

Type Attribute Name Description

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.25.123.114/webacs/api/v1/op/reportService/templates

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/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://172.25.123.114/webacs/api/v1/op/reportService/templates.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/reportService\/templates",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "savedReportTemplateDTO" : {
      "reportTitle" : "String value",
      "reportType" : "String value",
      "scheduled" : "String value",
      "virtualDomain" : "String value"
    }
  }
}