Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET

# GET reportService/getReport

- Jump To

### Resource Information

Rate Limiting? | Yes
Sorting? | No
Paging? | No
Filtering? | No
Response Formats | xml json
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.

## Resource URL

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

Since : 1.2

## Request Parameters

Type | Attribute Name | Description
--- | --- | ---
String | reportTitle required | The title of the saved report template that can be used to retrieve the latest report

## Response Parameters

Type | Attribute Name | Description
--- | --- | ---
ReportDataDTO[] | childReports | This is a collection of the nested child reports.
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.
Type | Attribute Name | Description
--- | --- | ---
ReportAttributeAndData[] | entries | This is a collection of information from the individual cells of a single row in a tabular report.
Type | Attribute Name | Description
--- | --- | ---
String | attributeName | The attribute name for the column header of this cell in a tabular report.
String | dataValue | The actual object value of this cell in a tabular report.
String | displayName | The display name of the column header from a tabular report.
String | descriptorName | The name of the report descriptor that defines the report template class of this report.
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.
Type | Attribute Name | Description
--- | --- | ---
CountInfoDTO[] | countInfo |
Type | Attribute Name | Description
--- | --- | ---
String | key | The key corresponding to a CountInfo Map entry
int | value | The Integer value corresponding to a CountInfo Map entry
Integer | currentPageSize |
Integer | dataRetrievedFromDb |
Integer | graphicalRowsCount |
Integer | maxRowsInGraph |
Integer | memoryNeeded |
Integer | offset |
Boolean | offsetPresent |
Integer | omittedRows |
Integer | pageSize |
Integer | totalCount |
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.
ReportDataRow[] | dataRows | This is a collection representing the information obtained from the rows of a tabular report.
Type | Attribute Name | Description
--- | --- | ---
ReportAttributeAndData[] | entries | This is a collection of information from the individual cells of a single row in a tabular report.
Type | Attribute Name | Description
--- | --- | ---
String | attributeName | The attribute name for the column header of this cell in a tabular report.
String | dataValue | The actual object value of this cell in a tabular report.
String | displayName | The display name of the column header from a tabular report.
String | descriptorName | The name of the report descriptor that defines the report template class of this report.
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.
Type | Attribute Name | Description
--- | --- | ---
CountInfoDTO[] | countInfo |
Type | Attribute Name | Description
--- | --- | ---
String | key | The key corresponding to a CountInfo Map entry
int | value | The Integer value corresponding to a CountInfo Map entry
Integer | currentPageSize |
Integer | dataRetrievedFromDb |
Integer | graphicalRowsCount |
Integer | maxRowsInGraph |
Integer | memoryNeeded |
Integer | offset |
Boolean | offsetPresent |
Integer | omittedRows |
Integer | pageSize |
Integer | totalCount |
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://192.168.116.207/webacs/api/v1/op/reportService/getReport?reportTitle=MyReport

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <mgmtResponse rootUrl="https://192.168.116.207/webacs/api/v1/op/reportService/reportService/getReport" requestUrl="https://192.168.116.207/webacs/api/v1/op/reportService/getReport?reportTitle=MyReport" responseType="operation">
        <reportDataDTO>
            <childReports>
                <childReport>
                    <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>
                                            <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>
                                    <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>
                            <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>
                    <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>
            <descriptorName>String value</descriptorName>
            <reportDate>String value</reportDate>
            <reportName>String value</reportName>
            <reportTitle>String value</reportTitle>
            <reportUrl>String value</reportUrl>
        </reportDataDTO>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@rootUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/reportService\/reportService\/getReport",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/reportService\/getReport?reportTitle=MyReport",
        "@responseType" : "operation",
        "reportDataDTO" : {
          "childReports" : {
            "childReport" : {
              "childReports" : {
                "childReport" : {
                  "childReports" : {
                    "childReport" : {
                      "childReports" : {
                        "childReport" : {
                          "dataRows" : {
                            "dataRow" : {
                              "entries" : {
                                "entry" : {
                                  "attributeName" : "String value",
                                  "dataValue" : "String value",
                                  "displayName" : "String value"
                                }
                              }
                            }
                          },
                          "descriptorName" : "String value",
                          "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",
                      "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",
                  "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",
              "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"
            }
          },
          "descriptorName" : "String value",
          "reportDate" : "String value",
          "reportName" : "String value",
          "reportTitle" : "String value",
          "reportUrl" : "String value"
        }
      }
    }