{"id":24230,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/addfieldlist-1\/"},"modified":"2025-02-17T09:38:25","modified_gmt":"2025-02-17T17:38:25","slug":"addfieldlist-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/","title":{"rendered":"add_field_list"},"content":{"rendered":"<p >This action provides a list of all the available fields to the user in a specific order that is used by the layout for adding new issues within ExtraView. Most typically, this script is used to provide a list of fields and their titles for inclusion in a Perl script that is used to insert a new record within the ExtraView database. This action is used as a basis of the CLI<span>&nbsp;<\/span><span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">evadd<\/span><span>&nbsp;<\/span>command. Note that all of the ExtraView security is in force and an individual user will only see the fields to which he has access. Also, note that there is no difference in the way that User Defined Fields (UDF\u2019s) are shown from other fields. UDF\u2019s are handled in a seamless way within the API.<\/p>\n<h3 >\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=add_field_list<br \/>\n\t[&amp;include_images=1]<\/span><\/p>\n<p >This will return a list of fields as shown in the following figure. Note that the fields will vary according to your permissions and the fields defined in your installation.<\/p>\n<p ><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">RESOLUTION Disposition<br \/>\n\tCUSTOMER Customer<br \/>\n\t+SHORT_DESCR Title<br \/>\n\tALT_ID Alt ID<br \/>\n\t+PRODUCT_NAME Product<br \/>\n\tPRIORITY Priority<br \/>\n\t+CATEGORY Category<br \/>\n\tSEVERITY_LEVEL Severity<br \/>\n\tASSIGNED_TO Assigned To<br \/>\n\tOWNER Owner<br \/>\n\tCOMPONENT Component<br \/>\n\tTEST_CASE_ID Test Case ID<br \/>\n\tTEST_CASE_LOCATION Test Case Location<br \/>\n\tPLATFORM Platforms<br \/>\n\tOS OS<br \/>\n\tPRIVACY View<br \/>\n\t*WORKAROUND Workaround<br \/>\n\t*RELEASE_NOTES Release Notes<br \/>\n\t+*DESCRIPTION Description<\/code><\/p>\n<h3 >\n\tNOTES<\/h3>\n<ul >\n<li style=\"list-style: outside url(&quot;\/misc\/menu-collapsed.png&quot;) disc; padding: 0px 0px 3px;\">\n\t\tThe general form of each entry returned by the command is:<\/p>\n<p>\t\t<span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">&lt;prefix&gt;&lt;fieldName&gt;&lt;delimiter&gt;&lt;fieldTitle&gt;&lt;delimiter&gt;&lt;parentName&gt;<\/span><\/p>\n<p>\t\twhere the parentName is blank or the immediate parent in an allowed-value or database-type relationship and the delimiter is that specified in the behavior setting named DEFAULT_TEXT_REPORT_DELIMITER and the characters in the prefix have the following meaning:<\/p>\n<p>\t\t<span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">~<span>&nbsp;<\/span><\/span>means the field is part of a repeating row layout<br \/>\n\t\t<span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">*<span>&nbsp;<\/span><\/span>means the field has a display type of textarea or logarea<br \/>\n\t\t<span class=\"fixedWidthFont\" style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">%<span>&nbsp;<\/span><\/span>means the field has a display type of user<\/li>\n<li style=\"list-style: outside url(&quot;\/misc\/menu-collapsed.png&quot;) disc; padding: 0px 0px 3px;\">\n\t\tThe parameter include_images is optional. If provided, it always has a value of 1. When the parameter is provided, fields with a display type of image are included in the results returned<\/li>\n<li style=\"list-style: outside url(&quot;\/misc\/menu-collapsed.png&quot;) disc; padding: 0px 0px 3px;\">\n\t\tThe optional<span>&nbsp;<\/span><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">access_token<\/code><span>&nbsp;<\/span>parameter allows you to use a valid OAuth2 token obtained with the<span>&nbsp;<\/span><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">get_token<\/code><span>&nbsp;<\/span>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<span>&nbsp;<\/span><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">user_id<\/code><span>&nbsp;<\/span>and<span>&nbsp;<\/span><code style=\"font-family: courier, monospace; color: rgb(170, 0, 0);\">password<\/code><span>&nbsp;<\/span>parameters should not be provided.&nbsp; This prevents the password being sent in clear text over your network connection.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>This action provides a list of all the available fields to the user in a specific order that is used by the layout for adding new issues within ExtraView. Most typically, this script is used to provide a list of fields and their titles for inclusion in a Perl script that is used to insert&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24223,"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-24230","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>add_field_list - 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\/addfieldlist-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"add_field_list - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This action provides a list of all the available fields to the user in a specific order that is used by the layout for adding new issues within ExtraView. Most typically, this script is used to provide a list of fields and their titles for inclusion in a Perl script that is used to insert...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T17:38: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\/addfieldlist-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/\",\"name\":\"add_field_list - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T17:38:25+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-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\":\"Application Programming Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"add_field_list\"}]},{\"@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":"add_field_list - 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\/addfieldlist-1\/","og_locale":"en_US","og_type":"article","og_title":"add_field_list - Product Documentation","og_description":"This action provides a list of all the available fields to the user in a specific order that is used by the layout for adding new issues within ExtraView. Most typically, this script is used to provide a list of fields and their titles for inclusion in a Perl script that is used to insert...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T17:38: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\/addfieldlist-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/","name":"add_field_list - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T17:38:25+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addfieldlist-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":"Application Programming Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/"},{"@type":"ListItem","position":4,"name":"add_field_list"}]},{"@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\/24230","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=24230"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24230\/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=24230"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}