{"id":24341,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/getheartbeat-4\/"},"modified":"2025-02-17T12:00:54","modified_gmt":"2025-02-17T20:00:54","slug":"getheartbeat-4","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/","title":{"rendered":"getHeartbeat"},"content":{"rendered":"

This API call provides an indication of the status of ExtraView. It is often used on a server remote to the ExtraView installation and called every few minutes to check that the ExtraView server is functioning correctly. If the call does not get a valid return, an alarm or notification may then be sent to an administrator.<\/p>\n

As the getHeartbeat call utilizes the API, care must be taken when the site is used with two factor authorization enabled via the ENABLE_TWO_FACTOR_AUTH behavior setting.\u00a0 The user account used to perform the request must be set to bypass 2FA, via its setting in the user account maintenance screen.\u00a0 This is required as there is no way in which an API call can enter the required second factor,<\/p>\n

Input<\/h3>\n\n\n\n\n\n
Class<\/td>\nName<\/td>\nType<\/td>\nRequired<\/td>\nDetails<\/td>\n<\/tr>\n
GetHeartbeatRequest<\/td>\nuserId<\/td>\nString<\/td>\nYes<\/td>\nThe callers user name<\/td>\n<\/tr>\n
GetHeartbeatRequest<\/td>\npassword<\/td>\nString<\/td>\nYes<\/td>\nThe callers password<\/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\n\n\n\n\n\n\n\n
Class<\/td>\nName<\/td>\nType<\/td>\nRequired<\/td>\nDetails<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\nsuccess<\/td>\nboolean<\/td>\nYes<\/td>\nTrue is succeeded False if failed<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\nreturnCode<\/td>\nString<\/td>\nNo<\/td>\nSee Appendix for details<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\nreturnMessage<\/td>\nString<\/td>\nNo<\/td>\nHuman readable message<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\nevStatus<\/td>\nString<\/td>\nYes<\/td>\nExtraView System Status<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\ndbStatus<\/td>\nString<\/td>\nYes<\/td>\nExtraView Database Status<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\ndbDate<\/td>\nDate<\/td>\nYes<\/td>\nThe current date in the Database<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\nfreeMemory<\/td>\nString<\/td>\nYes<\/td>\nFree memory on application server<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\ntotalMemory<\/td>\nInteger<\/td>\nYes<\/td>\nTotal memory on application server<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\nserviceCount<\/td>\nInteger<\/td>\nYes<\/td>\nThe current number of Extraview sessions<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\nexecuteTime<\/td>\nLong<\/td>\nYes<\/td>\nThe time it took to execute this call<\/td>\n<\/tr>\n
GetHeartbeatResponse<\/td>\ntasks<\/td>\nArray of TaskInfo<\/td>\nNo<\/td>\nThe information on tasks configured on the node of the server where the service is executed<\/td>\n<\/tr>\n
TaskInfo<\/td>\nnodeId<\/td>\nString<\/td>\nNo<\/td>\nThe name of the node hosting the service<\/td>\n<\/tr>\n
TaskInfo<\/td>\nstartOption<\/td>\nString<\/td>\nNo<\/td>\n<\/td>\n<\/tr>\n
TaskInfo<\/td>\ntaskState<\/td>\nString<\/td>\nNo<\/td>\nSTART_NOW, STOP_NOW, START_ON_BOOT, or none<\/td>\n<\/tr>\n
TaskInfo<\/td>\npollInterval<\/td>\nString<\/td>\nNo<\/td>\nThe minimum number of seconds between polled executions<\/td>\n<\/tr>\n
TaskInfo<\/td>\nthreads<\/td>\nArray of ThreadInfo<\/td>\nNo<\/td>\n<\/td>\n<\/tr>\n
ThreadInfo<\/td>\nthreadState<\/td>\nString<\/td>\nNo<\/td>\nRunning or stopped<\/td>\n<\/tr>\n
ThreadInfo<\/td>\nsecsSinceExecution<\/td>\nLong<\/td>\nNo<\/td>\nThe number of seconds since the task was most recently scheduled to run<\/td>\n<\/tr>\n
ThreadInfo<\/td>\npriority<\/td>\nLong<\/td>\nNo<\/td>\nThe priority of the thread (using Java thread priority values). This may not appear in the output<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example<\/h3>\n

public static void testGetHeartbeat(EVSystemServiceStub stub) {
\ntry {
\nGetHeartbeatDocument reqEnvelope = GetHeartbeatDocument.Factory.newInstance();
\nGetHeartbeatRequest request = reqEnvelope.addNewGetHeartbeat().addNewParam0();
\nrequest.setUserId(ServiceClientHelper.ADMIN_USER_ID);
\nrequest.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
\nGetHeartbeatResponseDocument resEnvelope = stub.getHeartbeat(reqEnvelope);
\nGetHeartbeatResponse response = resEnvelope.getGetHeartbeatResponse().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","protected":false},"excerpt":{"rendered":"

This API call provides an indication of the status of ExtraView. It is often used on a server remote to the ExtraView installation and called every few minutes to check that the ExtraView server is functioning correctly. If the call does not get a valid return, an alarm or notification may then be sent to…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24321,"menu_order":30,"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-24341","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\ngetHeartbeat - 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\/getheartbeat-4\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"getHeartbeat - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This API call provides an indication of the status of ExtraView. It is often used on a server remote to the ExtraView installation and called every few minutes to check that the ExtraView server is functioning correctly. If the call does not get a valid return, an alarm or notification may then be sent to...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T20:00:54+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=\"2 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\/getheartbeat-4\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/\",\"name\":\"getHeartbeat - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T20:00:54+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/#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\":\"getHeartbeat\"}]},{\"@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":"getHeartbeat - 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\/getheartbeat-4\/","og_locale":"en_US","og_type":"article","og_title":"getHeartbeat - Product Documentation","og_description":"This API call provides an indication of the status of ExtraView. It is often used on a server remote to the ExtraView installation and called every few minutes to check that the ExtraView server is functioning correctly. If the call does not get a valid return, an alarm or notification may then be sent to...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T20:00:54+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/","name":"getHeartbeat - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T20:00:54+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/getheartbeat-4\/#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":"getHeartbeat"}]},{"@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\/24341","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=24341"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24341\/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=24341"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}