{"id":22407,"date":"2024-02-15T14:48:40","date_gmt":"2024-02-15T22:48:40","guid":{"rendered":"https:\/\/docs.extraview.com\/v22\/book\/application-programming-interface\/"},"modified":"2024-02-15T14:48:40","modified_gmt":"2024-02-15T22:48:40","slug":"application-programming-interface","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/","title":{"rendered":"Application Programming Interface"},"content":{"rendered":"<p>This documentation covers the functionality of the ExtraView Programming Interface (API). This is a REpresentational State Transfer (RESTful) API This document is intended for the experienced computer user who has a good understanding of either the UNIX, Linux, or Microsoft Windows environments from which they will use the Application Programming Interface (API). To take maximum advantage of the features offered by the API, knowledge of web-based technologies are helpful. If you intend to modify the behavior of ExtraView with user custom programming, you will need to be skilled in coding with the Java language. In addition, ExtraView administration skills are required to configure many of the functions offered.<\/p>\n<h3>\n\tDownloadable PDF<\/h3>\n<p><a href=\"\/extraview-media\/files\/ExtraView-application-programming-interface-guide-22.1.pdf\" target=\"_blank\" rel=\"noopener\">The Application Programming Interface Guide is downloadable as a single PDF by clicking here<\/a>. You will need the <a href=\"http:\/\/www.adobe.com\" target=\"_blank\" rel=\"noopener\">Adobe Acrobat Reader<\/a> to view this.<\/p>\n<h3>\n\tRelated API Guides<\/h3>\n<ul>\n<li>\n\t\tCLI &#8211; Command Line Interface<\/li>\n<li>\n\t\tWeb Services Interface<\/li>\n<\/ul>\n<p>The key features of the RESTful API are:<\/p>\n<ul>\n<li>\n\t\tInsert, update and delete records in the ExtraView database from remote applications<\/li>\n<li>\n\t\tSearch the ExtraView database and return a set of records defined in a query<\/li>\n<li>\n\t\tExport information from the ExtraView database for input to a data warehouse<\/li>\n<li>\n\t\tUpload and download file attachments to and from the ExtraView database<\/li>\n<li>\n\t\tProvide limited administration access to create metadata and to manage user accounts<\/li>\n<li>\n\t\tShow the names of fields within the ExtraView database to which the user has access<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>This documentation covers the functionality of the ExtraView Programming Interface (API). This is a REpresentational State Transfer (RESTful) API This document is intended for the experienced computer user who has a good understanding of either the UNIX, Linux, or Microsoft Windows environments from which they will use the Application Programming Interface (API). To take maximum&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"","_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-22407","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Application Programming Interface - 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\/v22\/application-programming-interface\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Application Programming Interface - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This documentation covers the functionality of the ExtraView Programming Interface (API). This is a REpresentational State Transfer (RESTful) API This document is intended for the experienced computer user who has a good understanding of either the UNIX, Linux, or Microsoft Windows environments from which they will use the Application Programming Interface (API). To take maximum...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\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=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/\",\"url\":\"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/\",\"name\":\"Application Programming Interface - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#website\"},\"datePublished\":\"2024-02-15T22:48:40+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v22\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Application Programming Interface\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v22\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v22\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v22\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#\/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\/v22\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Application Programming Interface - 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\/v22\/application-programming-interface\/","og_locale":"en_US","og_type":"article","og_title":"Application Programming Interface - Product Documentation","og_description":"This documentation covers the functionality of the ExtraView Programming Interface (API). This is a REpresentational State Transfer (RESTful) API This document is intended for the experienced computer user who has a good understanding of either the UNIX, Linux, or Microsoft Windows environments from which they will use the Application Programming Interface (API). To take maximum...","og_url":"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/","og_site_name":"Product Documentation","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/","url":"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/","name":"Application Programming Interface - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v22\/#website"},"datePublished":"2024-02-15T22:48:40+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v22\/application-programming-interface\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v22\/application-programming-interface\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v22\/"},{"@type":"ListItem","position":2,"name":"Application Programming Interface"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v22\/#website","url":"https:\/\/docs.extraview.com\/v22\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v22\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v22\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v22\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v22\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v22\/#\/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\/v22\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v22\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22407","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/comments?post=22407"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22407\/revisions"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/media?parent=22407"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}