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

GET reportService/getReport

Deprecated

This resource does not supported. Please use the Run a ZIP Report or Get a ZIP Report resources.

This URL is used to retrieve the report data for a report that was previously generated from an asynchronous call of the reportService/report URL, or returns the latest result from a scheduled report generation.

The pageIndex request parameter can be specified to request a particular page. The pageCount response parameter can be used to identify how many total pages the report has.

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/v3/op/reportService/getReport

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 saved report template that can be used to retrieve the latest report

pageIndex Integer

query

Optional

The template's page number. The first page (when pageIndex equals zero) will be returned if page number is not specified.

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/v3/op/reportService/getReport?reportTitle=MyReport

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v3/op/reportService/getReport?reportTitle=MyReport" rootUrl="https://10.64.88.203/webacs/api/v3/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/v3/op/reportService/getReport.json?reportTitle=MyReport

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.88.203/webacs/api/v3/op/reportService/getReport?reportTitle=MyReport",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v3/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"
    } ]
  }
}