This resource does not support large report datasets. Please use the reportService/zipReport-GET or reportService/getReport-GET resources.
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? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/op/reportService/reportRequest Parameters
Attribute | Source | Description |
---|---|---|
reportTitle String |
query |
RequiredThe title of the report template to run. |
async Boolean |
query |
OptionalA boolean to specify if the call is asynchronous. Default is false. |
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://localhost/webacs/api/v1/op/reportService/report?reportTitle=MyReport
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/reportService/report?reportTitle=MyReport" rootUrl="https://localhost/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>
<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>
<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>
<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>
<reportTitle>String value</reportTitle>
<reportUrl>String value</reportUrl>
</reportDataDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/reportService/report.json?reportTitle=MyReport
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/reportService\/report?reportTitle=MyReport",
"@rootUrl" : "https : \/\/localhost\/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",
"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",
"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",
"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",
"reportTitle" : "String value",
"reportUrl" : "String value"
}
}
}