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

GET reportService/report

Deprecated

This resource does not support large report data sets. Please use the Run a ZIP Report or Get a Report resources.

This URL is used to generate reports from a specific saved report template and return the report output as an XML/JSON response.

It takes two arguments: a String reportTitle - a unique title of the saved report template, and a Boolean async indicating if the call is asynchronous when the value is true.

It provides the report data in the case of a synchronous call, or just provides a report URL using which the latest report can be retrieved.

Since Product Version: 1.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v2/op/reportService/report

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

reportTitle String

query

Required

The title of the report template to run.

async Boolean

query

Optional

A boolean to specify if the call is asynchronous. Default is false.

Response Parameters

Attribute Description

childReports Arrow image ReportDataDTO[]

This is a collection of the nested child reports.

dataRows Arrow image ReportDataRow[]

This is a collection representing the information obtained from the rows of a tabular report.

descriptorName String

The name of the report descriptor that defines the report template class of this report.

pageCount Integer

Total count of pages. Null for child reports.

pageIndex Integer

Page index of the current page. null for child reports.

reportDate String

The date and time when the report was generated.

reportName String

The name of the report.

reportTitle String

The name of the saved report template that was used to trigger this report.

reportUrl String

The URL that is used to retrieve the latest report generated for the specified reportTitle. It is useful to retrieve the report after an asynchronous run of report generation.

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.88.203/webacs/api/v2/op/reportService/report?reportTitle=MyReport

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v2/op/reportService/report?reportTitle=MyReport" rootUrl="https://10.64.88.203/webacs/api/v2/op">
  <reportDataDTO>
    <childReports></childReports>
    <dataRows>
      <dataRow>
        <entries>
          <entry>
            <attributeName>String value</attributeName>
            <dataValue>String value</dataValue>
            <displayName>String value</displayName>
          </entry>
          <entry>
            <attributeName>Another string value</attributeName>
            <dataValue>Another string value</dataValue>
            <displayName>Another string value</displayName>
          </entry>
        </entries>
      </dataRow>
      <dataRow>
        <entries>
          <entry>
            <attributeName>String value</attributeName>
            <dataValue>String value</dataValue>
            <displayName>String value</displayName>
          </entry>
          <entry>
            <attributeName>Another string value</attributeName>
            <dataValue>Another string value</dataValue>
            <displayName>Another string value</displayName>
          </entry>
        </entries>
      </dataRow>
    </dataRows>
    <descriptorName>String value</descriptorName>
    <pageCount>15</pageCount>
    <pageIndex>15</pageIndex>
    <reportDate>String value</reportDate>
    <reportName>String value</reportName>
    <reportTitle>String value</reportTitle>
    <reportUrl>String value</reportUrl>
  </reportDataDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/reportService/report.json?reportTitle=MyReport

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.88.203/webacs/api/v2/op/reportService/report?reportTitle=MyReport",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
    "reportDataDTO" : [ {
      "childReports" : {
        "childReport" : [ ]
      },
      "dataRows" : {
        "dataRow" : [ {
          "entries" : {
            "entry" : [ {
              "attributeName" : "String value",
              "dataValue" : "String value",
              "displayName" : "String value"
            }, {
              "attributeName" : "Another string value",
              "dataValue" : "Another string value",
              "displayName" : "Another string value"
            } ]
          }
        }, {
          "entries" : {
            "entry" : [ {
              "attributeName" : "String value",
              "dataValue" : "String value",
              "displayName" : "String value"
            }, {
              "attributeName" : "Another string value",
              "dataValue" : "Another string value",
              "displayName" : "Another string value"
            } ]
          }
        } ]
      },
      "descriptorName" : "String value",
      "pageCount" : 15,
      "pageIndex" : 15,
      "reportDate" : "String value",
      "reportName" : "String value",
      "reportTitle" : "String value",
      "reportUrl" : "String value"
    } ]
  }
}