This resource does not supported. Please use the Run a ZIP Report or Get a ZIP Report resources.
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
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (4)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- BNG IP Pool Statistics (3)
- BNG Sessions Statistics (3)
- CEM Statistics (3)
- CLI Template Configuration (12)
- Circuit Statistics (4)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Device Sensors Statistics (3)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- IPSLA (ICMP JITTER) Statistics (3)
- IPSLA Y1731 Statistics (3)
- Interface CRC Errors Statistics (3)
- Job Operations (6)
- Link Statistics (3)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Me1200 Quality of Service Statistics (3)
- Network Topology Layout (2)
- Optical Ethernet Statistics (3)
- Optical OTN Data Statistics (3)
- Optical Physical Statistics (3)
- Optical SFP Statistics (3)
- Optical Sonet SDH Statistics (3)
- PTP Clock Statistics (3)
- PTP and SyncE settings (5)
- Plug and Play (7)
- Quality of Service Statistics (3)
- Rate Limits Management Service (2)
- Report Service (5)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- SyncE Statistics (3)
- System Settings (26)
- TDM and Sonet Port Statistics (3)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- Y1731 Bins Statistics (3)
- v1
- v2
- v3
- v4
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 |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/reportService/getReportRequest 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 | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is a collection of the nested child reports. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
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://172.20.127.108/webacs/api/v1/op/reportService/getReport?reportTitle=MyReport
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v1/op/reportService/getReport?reportTitle=MyReport" rootUrl="https://172.20.127.108/webacs/api/v1/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://172.20.127.108/webacs/api/v1/op/reportService/getReport.json?reportTitle=MyReport
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/reportService\/getReport?reportTitle=MyReport",
"@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
"reportDataDTO" : {
"childReports" : "",
"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"
}
}
}
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/getReportUnmodified
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 | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is a collection of the nested child reports. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
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://172.20.127.108/webacs/api/v2/op/reportService/getReport?reportTitle=MyReport
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v2/op/reportService/getReport?reportTitle=MyReport" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v2/op/reportService/getReport.json?reportTitle=MyReport
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v2/op/reportService/getReport?reportTitle=MyReport",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/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"
} ]
}
}
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/getReportUnmodified
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 | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is a collection of the nested child reports. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
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://172.20.127.108/webacs/api/v3/op/reportService/getReport?reportTitle=MyReport
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v3/op/reportService/getReport?reportTitle=MyReport" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v3/op/reportService/getReport.json?reportTitle=MyReport
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v3/op/reportService/getReport?reportTitle=MyReport",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/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"
} ]
}
}
Resource unavailable for this API version
This resource was removed in API version 4.