INC Platform - Report Manager

Query Report Templates

Query report templates with certain criteria.

Interface URI

/report/reportTemplate

Access Method

HTTP
GET
Parameters
Query parameters
size Total returned records.
Integer type. Optional. The default value is 10. If the input value is smaller than 0, the default value is used.
start Location of the first returned record in the query result.
Integer type. Optional. The default value is 0. If the input value is smaller than 0, the default value is used
total Only records that match the sort criteria are returned.
Boolean type. Optional. The default value is false. When the value is true, the start and size attributes are invalid, the returned message body is empty, and the Message Header field gives the records that match the sort criteria.
templateName Report template name.
String type, supporting wildcard characters. Optional. No default value.
reportType Report type
>String type.Optional. No default value.
reportDefinedType Report definition type
nteger type. The default value is 1.Valid values include -1 (all), 0 (Pre-defined), 1 (Custom)

Returned Result

Status codes
  • 200 (OK): Success.
Message header
Message body
<list>
  <reportTemplate>
  <id>1</id>
  <name>Unused Interfaces Report</name>
  <location>en/INC-PLAT/unusedInterfaces.jasper</location>
  <reportType>Resource Statistics Report</templateId>
  <reportTypeID>7</reportTypeID>
  <customeDef>Pre-defined</customDef>
  <parameter>
    <parameterName>Device Label</parameterName>
    <dataType>Number</dataType>
  </parameter>
  <operatorGroup>
    <operatorGroupId>1</operatorGroupId>
    <operatorGroupName>Administrator Group</operatorGroupName>
  </operatorGroup>
</reportTemplate>
</list>
Elements
reportTemplate sub-elements
id Report template ID, which uniquely identifies a report template.
Long integer type.
name Report template name.
String type.
location Report template location.
String type.
reportTypeId Report Type ID.
Long integer type.
reportTypeName Report type name.
String type.
customeDef report definition type
Integer type
parameterName Parameter name.
String type.
dataType Parameter dataType.
String type.
operatorGroupId Operator group Id.
Long integer type.
operatorGroupName Operator group name.
String type.
 

Example

query report template

Request
GET http://host:8080/imcrs/report/reportTemplate
accept: application/xml
...
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<list>
 <reportTemplate>
  <id>1</id>
  <name>Unused Interfaces Report</name>
  <location>en/INC-PLAT/unusedInterfaces.jasper</location>
  <reportType>Resource Statistics Report</templateId>
  <reportTypeID>7</reportTypeID>
  <customeDef>Pre-defined</customDef>
  <parameter>
    <parameterName>Device Label</parameterName>
    <dataType>Number</dataType>
  </parameter>
  <operatorGroup>
    <operatorGroupId>1</operatorGroupId>
    <operatorGroupName>Administrator Group</operatorGroupName>
  </operatorGroup>
</reportTemplate>
<list>