{"id":24246,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/getfields-3\/"},"modified":"2025-02-17T09:51:25","modified_gmt":"2025-02-17T17:51:25","slug":"getfields-3","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/","title":{"rendered":"get_fields"},"content":{"rendered":"<p>This API call retrieves specific fields from an individual record from the ExtraView database. You must know the ID of the issue in question to be able to extract the information.<\/p>\n<h3 style=\"color: rgb(85, 85, 85); font-size: 12pt;\">\n\tSYNTAX<\/h3>\n<p><span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action?<br \/>\n\tuser_id=username<br \/>\n\t&amp;password=password<span>&nbsp;<\/span><\/span>OR<span>&nbsp;<\/span><span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">[&amp;access_token=token-value]<br \/>\n\t&amp;statevar=get_fields<br \/>\n\t&amp;username_display=ID | LAST | FIRST<br \/>\n\t&amp;id=nnnnn<br \/>\n\t&amp;status=1<br \/>\n\t&amp;priority=1<br \/>\n\t&amp;short_descr=1<br \/>\n\t&amp;comments=1<br \/>\n\t[&amp;all=yes]<\/span><br \/>\n\t<code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">[ev_send_xml=true]<br \/>\n\t[exclude_data_images=no | yes]<\/code><\/p>\n<p>The action retrieves only the fields requested from a single issue record in the database and displays the results with one field on each line. Note that only fields to which the user has permission will be displayed. Also, note that it is possible to see repeating fields such as version records within the output. The above command with the syntax given will return output similar to:<\/p>\n<p><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">Configuring the XYZ module results in an error<br \/>\n\tOPEN<br \/>\n\tMEDIUM<\/code><\/p>\n<h3 style=\"color: rgb(85, 85, 85); font-size: 12pt;\">\n\tNOTES<\/h3>\n<p>You must provide a valid name and value pair for the ID field. The value must be an existing issue within the ExtraView database. If you do not provide this, an error message is generated.<\/p>\n<p>The values returned may not be returned in the same order as the parameters you provide.<\/p>\n<p>The values returned are the NAMES or ID\u2019s of the fields set as parameters.<\/p>\n<p>The<span>&nbsp;<\/span><strong><span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">=1<\/span><\/strong><span>&nbsp;<\/span>in the parameter list is a mechanism to provide a dummy value. The number<span>&nbsp;<\/span><span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">1<\/span><span>&nbsp;<\/span>has no significance.<\/p>\n<p>The optional parameter<span>&nbsp;<\/span><span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">username_display<\/span><span>&nbsp;<\/span>may be used to override the behavior setting named USERNAME_DISPLAY, for the duration of the execution of a single API call. This allows the developer to return the user names in a different format than the system-wide default.<\/p>\n<p>When retrieving log area display type fields, such as the<span>&nbsp;<\/span><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">COMMENTS<span>&nbsp;<\/span><\/code>field in the above example, there is an optional parameter,<span>&nbsp;<\/span><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">all=yes<\/code>.&nbsp; When this is set, you will retrieve all the entries for the log area, not just the most recent one.<\/p>\n<p>The optional<span>&nbsp;<\/span><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">ev_send_xml<\/code><span>&nbsp;<\/span>will send the response to the command in XML format.<\/p>\n<p>If the data returned includes an image, the data for the image will be base 64 encoded.&nbsp; However, the optional parameter&nbsp;<code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">exclude_data_images<\/code>&nbsp;will inhibit images embedded within HTML Area fields from being output, if set to a value of&nbsp;<code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">yes<\/code>.<\/p>\n<p>The optional&nbsp;<code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">access_token<\/code>&nbsp;parameter allows you to use a valid OAuth2 token obtained with the&nbsp;<code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">get_token<\/code>&nbsp;command.&nbsp; If you provide the&nbsp;<code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">access_token<\/code>&nbsp;parameter, then the&nbsp;<code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">user_id<\/code>&nbsp;and&nbsp;<code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">password<\/code>&nbsp;parameters should not be provided.&nbsp; This prevents the password being sent in clear text over your network connection.<\/p>\n<p>\t&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>This API call retrieves specific fields from an individual record from the ExtraView database. You must know the ID of the issue in question to be able to extract the information. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &amp;password=password&nbsp;OR&nbsp;[&amp;access_token=token-value] &amp;statevar=get_fields &amp;username_display=ID | LAST | FIRST &amp;id=nnnnn &amp;status=1 &amp;priority=1 &amp;short_descr=1 &amp;comments=1 [&amp;all=yes] [ev_send_xml=true] [exclude_data_images=no | yes] The action retrieves only&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24223,"menu_order":34,"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-24246","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>get_fields - 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\/application-programming-interface-1\/getfields-3\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"get_fields - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This API call retrieves specific fields from an individual record from the ExtraView database. You must know the ID of the issue in question to be able to extract the information. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &amp;password=password&nbsp;OR&nbsp;[&amp;access_token=token-value] &amp;statevar=get_fields &amp;username_display=ID | LAST | FIRST &amp;id=nnnnn &amp;status=1 &amp;priority=1 &amp;short_descr=1 &amp;comments=1 [&amp;all=yes] [ev_send_xml=true] [exclude_data_images=no | yes] The action retrieves only...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T17:51:25+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\/application-programming-interface-1\/getfields-3\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/\",\"name\":\"get_fields - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T17:51:25+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/#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\":\"Application Programming Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"get_fields\"}]},{\"@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":"get_fields - 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\/application-programming-interface-1\/getfields-3\/","og_locale":"en_US","og_type":"article","og_title":"get_fields - Product Documentation","og_description":"This API call retrieves specific fields from an individual record from the ExtraView database. You must know the ID of the issue in question to be able to extract the information. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &amp;password=password&nbsp;OR&nbsp;[&amp;access_token=token-value] &amp;statevar=get_fields &amp;username_display=ID | LAST | FIRST &amp;id=nnnnn &amp;status=1 &amp;priority=1 &amp;short_descr=1 &amp;comments=1 [&amp;all=yes] [ev_send_xml=true] [exclude_data_images=no | yes] The action retrieves only...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T17:51:25+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\/application-programming-interface-1\/getfields-3\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/","name":"get_fields - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T17:51:25+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getfields-3\/#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":"Application Programming Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/"},{"@type":"ListItem","position":4,"name":"get_fields"}]},{"@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\/24246","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=24246"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24246\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24223"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24246"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}