{"id":24329,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/executereport-1\/"},"modified":"2025-02-17T10:57:56","modified_gmt":"2025-02-17T18:57:56","slug":"executereport-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/","title":{"rendered":"executeReport"},"content":{"rendered":"

This function runs an existing report, using its report_id<\/em>. This is obtained from the get_reports<\/em> function.<\/p>\n

Input<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n
Class<\/td>\nName<\/td>\nType<\/td>\nRequired<\/td>\nDetails<\/td>\n<\/tr>\n
ExecuteReportRequest<\/td>\nuserId<\/td>\nString<\/td>\nYes<\/td>\nThe caller’s user name<\/td>\n<\/tr>\n
ExecuteReportRequest<\/td>\npassword<\/td>\nString<\/td>\nYes<\/td>\nThe caller’s password<\/td>\n<\/tr>\n
ExecuteReportRequest<\/td>\nstatus<\/td>\nString<\/td>\nNo<\/td>\nThe status of the items being collected<\/td>\n<\/tr>\n
ExecuteReportRequest<\/td>\npageLength<\/td>\nInteger<\/td>\nYes<\/td>\nThe page length<\/td>\n<\/tr>\n
ExecuteReportRequest<\/td>\npersistHandle<\/td>\nString<\/td>\nNo<\/td>\nA random string to persist the data<\/td>\n<\/tr>\n
ExecuteReportRequest<\/td>\nrecordStart<\/td>\nInteger<\/td>\nNo<\/td>\nThe starting index of records returned<\/td>\n<\/tr>\n
ExecuteReportRequest<\/td>\nrecordCount<\/td>\nInteger<\/td>\nNo<\/td>\nThe count of records being fetched<\/td>\n<\/tr>\n
ExecuteReportRequest<\/td>\nreturnRawXML<\/td>\nboolean<\/td>\nNo<\/td>\nDetermines whether raw XML will be returned with the parse fields. This should be set to false for better performance<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Output<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Class<\/td>\nName<\/td>\nType<\/td>\nRequired<\/td>\nDetails<\/td>\n<\/tr>\n
ExecuteReportResponse<\/td>\nsuccess<\/td>\nboolean<\/td>\nYes<\/td>\nTrue is succeeded False if failed<\/td>\n<\/tr>\n
ExecuteReportResponse<\/td>\nreturnCode<\/td>\nString<\/td>\nNo<\/td>\nSee Appendix for details<\/td>\n<\/tr>\n
ExecuteReportResponse<\/td>\nreturnMessage<\/td>\nString<\/td>\nNo<\/td>\nHuman readable message<\/td>\n<\/tr>\n
ExecuteReportResponse<\/td>\nxmlResults<\/td>\nString<\/td>\nNo<\/td>\nThe search results in XML format<\/td>\n<\/tr>\n
ExecuteReportResponse<\/td>\nitemRecords<\/td>\nArray[]<\/td>\nYes<\/td>\nAn array of ItemRecord objects<\/td>\n<\/tr>\n
ItemRecord<\/td>\nnumberOfItemRecordFields<\/td>\nint<\/td>\nYes<\/td>\nThe number of field records in the child array<\/td>\n<\/tr>\n
ItemRecord<\/td>\nitemRecordFields<\/td>\nArray[]<\/td>\nYes<\/td>\nAn array of ItemRecordField objects<\/td>\n<\/tr>\n
ItemRecordField<\/td>\nfieldId<\/td>\nString<\/td>\nYes<\/td>\nThe id of the field<\/td>\n<\/tr>\n
ItemRecordField<\/td>\nfieldTitle<\/td>\nString<\/td>\nYes<\/td>\nThe title of the field<\/td>\n<\/tr>\n
ItemRecordField<\/td>\nfieldValue<\/td>\nString<\/td>\nYes<\/td>\nThe value of the field<\/td>\n<\/tr>\n
ItemRecordField<\/td>\nrow<\/td>\nint<\/td>\nYes<\/td>\nThe repeating row value<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example 1<\/h3>\n

public static void testExecuteReport(EVReportServiceStub stub) {
\ntry {
\nExecuteReportDocument reqEnvelope = ExecuteReportDocument.Factory.newInstance();
\nExecuteReportRequest request = reqEnvelope.addNewExecuteReport().addNewRequest();
\nrequest.setUserId(ServiceClientHelper.ADMIN_USER_ID);
\nrequest.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
\nrequest.setPageLength(100);
\nrequest.setRecordStart(1);
\nrequest.setRecordCount(120);
\nrequest.setPersistHandle(ServiceClientHelper.randStr);
\nrequest.setReportId(ServiceClientHelper.STANDARD_REPORT);
\nExecuteReportResponseDocument resEnvelope = stub.executeReport(reqEnvelope);
\nExecuteReportResponse response = resEnvelope.getExecuteReportResponse().getReturn();
\nif (response.getSuccess()) {
\nSystem.out.println(\"success: [\" + response.getReturnCode() + \"] : \" +
\nresponse.getReturnMessage());
\n} else {
\nSystem.out.println(\"failure: [\" + response.getReturnCode() + \"] : \" +
\nresponse.getReturnMessage());
\n}
\n} catch (Exception e) {
\ne.printStackTrace();
\nSystem.err.println(\"nnn\");
\n}
\n}<\/code><\/p>\n

Example 2<\/h3>\n

This is sample code for specifying runtime filters for a hierarchy report:<\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 executeReport request = new executeReport();
\n\/* fill with minimum data set *\/
\nrequest.setSearchMode(\"ADVANCED\");
\nrequest.setApiReverseLookup(\"YES\");
\nList<AdvancedFilterData> filters = new ArrayList<AdvancedFilterData>();
\nAdvancedFilterData filter = null;
\n\/\/ Priority = P 1 at base level
\nfilter = new AdvancedFilterData();
\nfilter.setFset(\"0\");
\nfilter.setFieldName(\"PRIORITY\");
\nfilter.setOperator(\"=\");
\nfilter.setValue1_EVDISPLAY(\"P 1\");
\nfilter.setMvalue1(\"\");
\nfilter.setValue2(\"\");
\nfilters.add(filter);
\n\/\/ \u00a0DATE_CREATED between 09\/01\/2017 and 09\/30\/2017 at hierarchy level 1
\nfilter = new AdvancedFilterData();
\nfilter.setFset(\"1\");
\nfilter.setFieldName(\"DATE_CREATED\");
\nfilter.setOperator(\"between\");
\nfilter.setValue1_EVDISPLAY(\"09\/01\/2017\");
\nfilter.setMvalue1(\"09\/01\/2017\");
\nfilter.setValue2(\"09\/30\/2017\");
\nfilters.add(filter);
\nrequest.setAdvancedFilterData(filters.toArray(new AdvancedFilterData[filters.size()]));<\/code><\/p>\n

Example 3<\/h3>\n

This is sample code for specifying runtime filters a non-hierarchy report<\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 executeReport request = new executeReport();
\n\/* fill with minimum data set *\/
\nrequest.setSearchMode(\"ADVANCED\");
\nrequest.setApiReverseLookup(\"YES\");
\nList<AdvancedFilterData> filters = new ArrayList<AdvancedFilterData>();
\nAdvancedFilterData filter = null;
\n\/\/ Priority = P 1
\nfilter = new AdvancedFilterData();
\nfilter.setFset(\"0\");\u00a0 \/\/ non-hierarhcy
\nfilter.setFieldName(\"PRIORITY\");
\nfilter.setOperator(\"=\");
\nfilter.setValue1_EVDISPLAY(\"P 1\");
\nfilter.setMvalue1(\"\");
\nfilter.setValue2(\"\");
\nfilters.add(filter);
\n\/\/ \u00a0DATE_CREATED between 09\/01\/2017 and 09\/30\/2017
\nfilter = new AdvancedFilterData();
\nfilter.setFset(\"0\");\u00a0 \/\/ non-hierarhcy
\nfilter.setFieldName(\"DATE_CREATED\");
\nfilter.setOperator(\"between\");
\nfilter.setValue1_EVDISPLAY(\"09\/01\/2017\");
\nfilter.setMvalue1(\"09\/01\/2017\");
\nfilter.setValue2(\"09\/30\/2017\");
\nfilters.add(filter);
\nrequest.setAdvancedFilterData(filters.toArray(new AdvancedFilterData[filters.size()]));<\/code><\/p>\n

Example 4<\/h3>\n

This is sample code for specifying runtime filters along with standard filters within a hierarchy report<\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 executeReport request = new executeReport();
\n\/* fill with minimum data set *\/
\nrequest.setApiReverseLookup(\"YES\");
\nList<FilterData> filters = new ArrayList<FilterData>();
\nFilterData filter = null;
\n\/\/ Priority = P 1
\nfilter = new FilterData();
\nfilter.setName(\"PRIORITY\");
\nfilter.setValue(\"P 1\");
\nfilters.add(filter);
\n\/\/ Category= Software
\nfilter = new FilterData();
\nfilter.setName(\"CATEGORY\");
\nfilter.setValue(\"Software\");
\nfilters.add(filter);
\nrequest.setFilterData(filters.toArray(new FilterData[filters.size()]));<\/code><\/p>\n","protected":false},"excerpt":{"rendered":"

This function runs an existing report, using its report_id. This is obtained from the get_reports function. Input Class Name Type Required Details ExecuteReportRequest userId String Yes The caller’s user name ExecuteReportRequest password String Yes The caller’s password ExecuteReportRequest status String No The status of the items being collected ExecuteReportRequest pageLength Integer Yes The page length…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24321,"menu_order":6,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24329","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nexecuteReport - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"executeReport - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This function runs an existing report, using its report_id. This is obtained from the get_reports function. Input Class Name Type Required Details ExecuteReportRequest userId String Yes The caller’s user name ExecuteReportRequest password String Yes The caller’s password ExecuteReportRequest status String No The status of the items being collected ExecuteReportRequest pageLength Integer Yes The page length...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T18:57:56+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/\",\"name\":\"executeReport - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T18:57:56+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Web Services Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"executeReport\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"executeReport - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/","og_locale":"en_US","og_type":"article","og_title":"executeReport - Product Documentation","og_description":"This function runs an existing report, using its report_id. This is obtained from the get_reports function. Input Class Name Type Required Details ExecuteReportRequest userId String Yes The caller’s user name ExecuteReportRequest password String Yes The caller’s password ExecuteReportRequest status String No The status of the items being collected ExecuteReportRequest pageLength Integer Yes The page length...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T18:57:56+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/","name":"executeReport - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T18:57:56+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/executereport-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Web Services Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/"},{"@type":"ListItem","position":4,"name":"executeReport"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24329","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24329"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24329\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24321"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24329"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}