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

GET reportService/getReport

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 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.

Since Product Version: 1.2

Resource URL

/webacs/api/v1/op/reportService/getReport

Request Parameters

Type Attribute Name Source Description

String

reportTitle required

query

The title of the saved report template that can be used to retrieve the latest report

Integer

pageIndex optional

query

The template's page number. The first page will be returned if page number is not specified.

Response Parameters

Type Attribute Name Description

ReportDataDTO[]

childReports

This is a collection of the nested child reports.

ReportDataRow[]

dataRows

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

String

descriptorName

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

Integer

pageCount

Total count of pages. Null for child reports.

Integer

pageIndex

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

String

reportDate

The date and time when the report was generated.

String

reportName

The name of the report.

ReportPageSettingsDTO

reportPageSettings

The updated report page settings information after a report generation.

String

reportTitle

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

String

reportUrl

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://172.25.123.114/webacs/api/v1/op/reportService/getReport?reportTitle=MyReport

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/reportService/getReport?reportTitle=MyReport" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <reportDataDTO>
    <childReports>
      <childReport>
        <childReports>
          <childReport>
            <childReports>
              <childReport>
                <dataRows>
                  <dataRow>
                    <entries>
                      <entry>
                        <attributeName>String value</attributeName>
                        <dataValue>String value</dataValue>
                        <displayName>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>
                <reportPageSettings>
                  <countInfo>
                    <countInfo>
                      <key>String value</key>
                      <value>1</value>
                    </countInfo>
                  </countInfo>
                  <currentPageSize>15</currentPageSize>
                  <dataRetrievedFromDb>15</dataRetrievedFromDb>
                  <graphicalRowsCount>15</graphicalRowsCount>
                  <maxRowsInGraph>15</maxRowsInGraph>
                  <memoryNeeded>15</memoryNeeded>
                  <offset>15</offset>
                  <offsetPresent>true</offsetPresent>
                  <omittedRows>15</omittedRows>
                  <pageSize>15</pageSize>
                  <totalCount>15</totalCount>
                </reportPageSettings>
                <reportTitle>String value</reportTitle>
                <reportUrl>String value</reportUrl>
              </childReport>
            </childReports>
            <dataRows>
              <dataRow>
                <entries>
                  <entry>
                    <attributeName>String value</attributeName>
                    <dataValue>String value</dataValue>
                    <displayName>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>
            <reportPageSettings>
              <countInfo>
                <countInfo>
                  <key>String value</key>
                  <value>1</value>
                </countInfo>
              </countInfo>
              <currentPageSize>15</currentPageSize>
              <dataRetrievedFromDb>15</dataRetrievedFromDb>
              <graphicalRowsCount>15</graphicalRowsCount>
              <maxRowsInGraph>15</maxRowsInGraph>
              <memoryNeeded>15</memoryNeeded>
              <offset>15</offset>
              <offsetPresent>true</offsetPresent>
              <omittedRows>15</omittedRows>
              <pageSize>15</pageSize>
              <totalCount>15</totalCount>
            </reportPageSettings>
            <reportTitle>String value</reportTitle>
            <reportUrl>String value</reportUrl>
          </childReport>
        </childReports>
        <dataRows>
          <dataRow>
            <entries>
              <entry>
                <attributeName>String value</attributeName>
                <dataValue>String value</dataValue>
                <displayName>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>
        <reportPageSettings>
          <countInfo>
            <countInfo>
              <key>String value</key>
              <value>1</value>
            </countInfo>
          </countInfo>
          <currentPageSize>15</currentPageSize>
          <dataRetrievedFromDb>15</dataRetrievedFromDb>
          <graphicalRowsCount>15</graphicalRowsCount>
          <maxRowsInGraph>15</maxRowsInGraph>
          <memoryNeeded>15</memoryNeeded>
          <offset>15</offset>
          <offsetPresent>true</offsetPresent>
          <omittedRows>15</omittedRows>
          <pageSize>15</pageSize>
          <totalCount>15</totalCount>
        </reportPageSettings>
        <reportTitle>String value</reportTitle>
        <reportUrl>String value</reportUrl>
      </childReport>
    </childReports>
    <dataRows>
      <dataRow>
        <entries>
          <entry>
            <attributeName>String value</attributeName>
            <dataValue>String value</dataValue>
            <displayName>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>
    <reportPageSettings>
      <countInfo>
        <countInfo>
          <key>String value</key>
          <value>1</value>
        </countInfo>
      </countInfo>
      <currentPageSize>15</currentPageSize>
      <dataRetrievedFromDb>15</dataRetrievedFromDb>
      <graphicalRowsCount>15</graphicalRowsCount>
      <maxRowsInGraph>15</maxRowsInGraph>
      <memoryNeeded>15</memoryNeeded>
      <offset>15</offset>
      <offsetPresent>true</offsetPresent>
      <omittedRows>15</omittedRows>
      <pageSize>15</pageSize>
      <totalCount>15</totalCount>
    </reportPageSettings>
    <reportTitle>String value</reportTitle>
    <reportUrl>String value</reportUrl>
  </reportDataDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/reportService/getReport.json?reportTitle=MyReport

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/reportService\/getReport?reportTitle=MyReport",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "reportDataDTO" : {
      "childReports" : {
        "childReport" : {
          "childReports" : {
            "childReport" : {
              "childReports" : {
                "childReport" : {
                  "dataRows" : {
                    "dataRow" : {
                      "entries" : {
                        "entry" : {
                          "attributeName" : "String value",
                          "dataValue" : "String value",
                          "displayName" : "String value"
                        }
                      }
                    }
                  },
                  "descriptorName" : "String value",
                  "pageCount" : 15,
                  "pageIndex" : 15,
                  "reportDate" : "String value",
                  "reportName" : "String value",
                  "reportPageSettings" : {
                    "countInfo" : {
                      "countInfo" : {
                        "key" : "String value",
                        "value" : 1
                      }
                    },
                    "currentPageSize" : 15,
                    "dataRetrievedFromDb" : 15,
                    "graphicalRowsCount" : 15,
                    "maxRowsInGraph" : 15,
                    "memoryNeeded" : 15,
                    "offset" : 15,
                    "offsetPresent" : true,
                    "omittedRows" : 15,
                    "pageSize" : 15,
                    "totalCount" : 15
                  },
                  "reportTitle" : "String value",
                  "reportUrl" : "String value"
                }
              },
              "dataRows" : {
                "dataRow" : {
                  "entries" : {
                    "entry" : {
                      "attributeName" : "String value",
                      "dataValue" : "String value",
                      "displayName" : "String value"
                    }
                  }
                }
              },
              "descriptorName" : "String value",
              "pageCount" : 15,
              "pageIndex" : 15,
              "reportDate" : "String value",
              "reportName" : "String value",
              "reportPageSettings" : {
                "countInfo" : {
                  "countInfo" : {
                    "key" : "String value",
                    "value" : 1
                  }
                },
                "currentPageSize" : 15,
                "dataRetrievedFromDb" : 15,
                "graphicalRowsCount" : 15,
                "maxRowsInGraph" : 15,
                "memoryNeeded" : 15,
                "offset" : 15,
                "offsetPresent" : true,
                "omittedRows" : 15,
                "pageSize" : 15,
                "totalCount" : 15
              },
              "reportTitle" : "String value",
              "reportUrl" : "String value"
            }
          },
          "dataRows" : {
            "dataRow" : {
              "entries" : {
                "entry" : {
                  "attributeName" : "String value",
                  "dataValue" : "String value",
                  "displayName" : "String value"
                }
              }
            }
          },
          "descriptorName" : "String value",
          "pageCount" : 15,
          "pageIndex" : 15,
          "reportDate" : "String value",
          "reportName" : "String value",
          "reportPageSettings" : {
            "countInfo" : {
              "countInfo" : {
                "key" : "String value",
                "value" : 1
              }
            },
            "currentPageSize" : 15,
            "dataRetrievedFromDb" : 15,
            "graphicalRowsCount" : 15,
            "maxRowsInGraph" : 15,
            "memoryNeeded" : 15,
            "offset" : 15,
            "offsetPresent" : true,
            "omittedRows" : 15,
            "pageSize" : 15,
            "totalCount" : 15
          },
          "reportTitle" : "String value",
          "reportUrl" : "String value"
        }
      },
      "dataRows" : {
        "dataRow" : {
          "entries" : {
            "entry" : {
              "attributeName" : "String value",
              "dataValue" : "String value",
              "displayName" : "String value"
            }
          }
        }
      },
      "descriptorName" : "String value",
      "pageCount" : 15,
      "pageIndex" : 15,
      "reportDate" : "String value",
      "reportName" : "String value",
      "reportPageSettings" : {
        "countInfo" : {
          "countInfo" : {
            "key" : "String value",
            "value" : 1
          }
        },
        "currentPageSize" : 15,
        "dataRetrievedFromDb" : 15,
        "graphicalRowsCount" : 15,
        "maxRowsInGraph" : 15,
        "memoryNeeded" : 15,
        "offset" : 15,
        "offsetPresent" : true,
        "omittedRows" : 15,
        "pageSize" : 15,
        "totalCount" : 15
      },
      "reportTitle" : "String value",
      "reportUrl" : "String value"
    }
  }
}