getReportHandle
The getReportHandle command returns all the report handles available to the calling user.
Input
|
Class |
Name |
Type |
Required |
Details |
|
GetReportHandleRequest |
userId |
String |
Yes |
The caller’s user name |
|
GetReportHandleRequest |
password |
String |
Yes |
The caller’s password |
Output
|
Class |
Name |
Type |
Required |
Details |
|
GetReportHandleResponse |
success |
boolean |
Yes |
True is succeeded False if failed |
|
GetReportHandleResponse |
returnCode |
String |
No |
See Appendix for details |
|
GetReportHandleResponse |
returnMessage |
String |
No |
Human readable message |
|
GetReportHandleResponse |
reportHandles |
Array[] |
No |
The date the attachment was added to the item |
|
ReportHandle |
reportId |
int |
Yes |
The report Id |
|
ReportHandle |
owner |
String |
Yes |
PUBLIC, PRIVATE or UNKNOWN |
|
ReportHandle |
reportType |
String |
Yes |
See the Appendix on Report Type Table |
|
ReportHandle |
ReportTitle |
String |
Yes |
The title of the report |
|
ReportHandle |
reportDesc |
String |
Yes |
The description of the report |
Example
public static void testGetReportHandle(EVQueryServiceStub stub) {
try {
GetReportHandleDocument reqEnvelope = GetReportHandleDocument.Factory.newInstance();
GetReportHandleRequest request = reqEnvelope.addNewGetReportHandle().addNewRequest();
request.setUserId(ServiceClientHelper.ADMIN_USER_ID);
request.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
GetReportHandleResponseDocument resEnvelope = stub.getReportHandle(reqEnvelope);
GetReportHandleResponse response =
resEnvelope.getGetReportHandleResponse().getReturn();
if (response.getSuccess()) {
System.out.println("success: [" + response.getReturnCode() + "] : " +
response.getReturnMessage());
for (ReportHandle reportHandle: response.getReportHandlesArray()) {
System.out.println(" +++++++++++++++++ ");
System.out.println(" Report Handle: ");
System.out.println(" - Report Id: " + reportHandle.getReportId());
System.out.println(" - Owner: " + reportHandle.getOwner());
System.out.println(" - Type: " + reportHandle.getReportType());
System.out.println(" - Title: " + reportHandle.getReportTitle());
System.out.println(" - Desc: " + reportHandle.getReportDesc());
}
} else {
System.out.println("failure: [" + response.getReturnCode() + "] : " +
response.getReturnMessage());
}
} catch (Exception e) {
e.printStackTrace();
System.err.println("nnn");
}
}