{"id":24258,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/getvalidmetadata-1\/"},"modified":"2025-02-17T10:01:52","modified_gmt":"2025-02-17T18:01:52","slug":"getvalidmetadata-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/","title":{"rendered":"get_valid_meta_data"},"content":{"rendered":"

This action retrieves a complete list of the metadata stored in ExtraView.<\/p>\n

\n\tSYNTAX<\/h3>\n

http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action?
\n\tuser_id=username
\n\t&password=password<\/span> <\/span>OR <\/span>[&access_token=token-value]
\n\t&password=password
\n\t&statevar=get_valid_meta_data
\n\t&fields=field_x<\/em>
\n\t&user_info=x
\n\t&disabled_values=Y
\n\t&all=Y<\/span><\/p>\n

\n\tNOTES<\/h3>\n

This function can return a significant amount of data, depending on your installation.<\/p>\n

By default, the data returned is for the user\u2019s current area and project only.<\/p>\n

By default, the data returned is also filtered by any allowed values. For example, if there is an allowed value with the field named STATUS as the parent, then only the child records in the current area will be returned.<\/p>\n

The previous two default conditions can be overridden, by using the optional parameter <\/span>all=Y<\/span> <\/span>as part of the call.<\/p>\n

The optional parameter <\/span>fields<\/span> <\/span>can be used to refine the metadata returned to a single, or to a list of fields. For example, <\/span>fields=CUST_LIST<\/span> <\/span>will return the metadata associated with the <\/span>CUST_LIST<\/span> <\/span>field. You can repeat this parameter as many times as you need in the parameter list, to return the metadata on a number of fields with a single command.<\/p>\n

The optional parameter <\/span>disabled_values<\/span> <\/span>wlil return all the users, including those that are disabled, within the output to the command.<\/p>\n

The optional parameter <\/span>user_info<\/span> <\/span>has three possible functions:<\/p>\n

    \n
  1. \n\t\tWhen no parameter is specified, the command works as documented in the other sections of this page<\/li>\n
  2. \n\t\tWhen the parameter has a value of <\/span>N<\/span> <\/span>then no user information is generated in the return of the call<\/li>\n
  3. \n\t\tWhen the parameter has a value of <\/span>Y<\/span> <\/span>then one set of generic information is returned, with <\/span>SECURITY_USER_ID<\/span> <\/span>being used as the field ID.<\/li>\n<\/ol>\n

    The security permissions for each field are checked for the user performing the API command, and only fields to which the user has read permission are returned.<\/p>\n

    The result of the function is in the form:<\/p>\n

    field_name:meta_data_name:meta_data_title<\/span><\/p>\n

    where the delimiter : is the system delimiter stored in the behavior setting named DEFAULT_TEXT_REPORT_DELIMITER.<\/p>\n

    The optional access_token<\/code> parameter allows you to use a valid OAuth2 token obtained with the get_token<\/code> command.  If you provide the access_token<\/code> parameter, then the user_id<\/code> and password<\/code> parameters should not be provided.  This prevents the password being sent in clear text over your network connection.<\/p>\n

    A small sample of data returned is shown below – note the delimiter in this case is the | character:<\/p>\n

    \n\tCATEGORY|ENHANCEMENT|Enhancement<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tCATEGORY|HARDWARE|Hardware<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tCATEGORY|SOFTWARE|Software<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tOS|5755|FREEBSD OS|5721|LINUX<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tOS|5913|NetBSD<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tOS|5711|SOLARIS<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tOS|5752|WINDOWS 95<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tOS|5787|WINDOWS 98<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tOS|5704|WINDOWS NT<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRIORITY|0|0<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRIORITY|1|1<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRIORITY|2|2<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRIORITY|3|3<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRIORITY|4|4<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRIORITY|5|5<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRIVACY|PRIVATE|Private<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRIVACY|PUBLIC|Public<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRODUCT_NAME|GLOBALINTERACTION|Global Interaction<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tPRODUCT_NAME|NETTRANSACTIONS|Net Transactions<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRELEASE_STATUS|CLOSED|Closed<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRELEASE_STATUS|FIXED|Fixed<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRELEASE_STATUS|OPEN|Open<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRELEASE_STATUS|PENDING|Pending<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRELEASE_STATUS|UNASSIGNED|Unassigned<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRESOLUTION|CANNOT DUPLICATE|Cannot Duplicate<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRESOLUTION|DEFERRED|Deferred<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRESOLUTION|DUPLICATE|Duplicate<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRESOLUTION|FIXED|Fixed<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tRESOLUTION|NEED MORE INFO|Need more info<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tSEVERITY_LEVEL|CRITICAL|Critical<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tSEVERITY_LEVEL|HIGH|High<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tSEVERITY_LEVEL|LOW|Low<\/code><\/div>\n
    \n\t <\/div>\n
    \n\tSEVERITY_LEVEL|MEDIUM|Medium<\/code><\/div>\n

     <\/p>\n","protected":false},"excerpt":{"rendered":"

    This action retrieves a complete list of the metadata stored in ExtraView. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &password=password &statevar=get_valid_meta_data &fields=field_x &user_info=x &disabled_values=Y &all=Y NOTES This function can return a significant amount of data, depending on your installation. By default, the data returned is for the user\u2019s current area and project only. By default, the data returned…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24223,"menu_order":51,"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-24258","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nget_valid_meta_data - 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\/getvalidmetadata-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"get_valid_meta_data - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This action retrieves a complete list of the metadata stored in ExtraView. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &password=password &statevar=get_valid_meta_data &fields=field_x &user_info=x &disabled_values=Y &all=Y NOTES This function can return a significant amount of data, depending on your installation. By default, the data returned is for the user\u2019s current area and project only. By default, the data returned...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T18:01:52+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\/application-programming-interface-1\/getvalidmetadata-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/\",\"name\":\"get_valid_meta_data - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T18:01:52+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-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\":\"get_valid_meta_data\"}]},{\"@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_valid_meta_data - 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\/getvalidmetadata-1\/","og_locale":"en_US","og_type":"article","og_title":"get_valid_meta_data - Product Documentation","og_description":"This action retrieves a complete list of the metadata stored in ExtraView. SYNTAX http:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? user_id=username &password=password OR [&access_token=token-value] &password=password &statevar=get_valid_meta_data &fields=field_x &user_info=x &disabled_values=Y &all=Y NOTES This function can return a significant amount of data, depending on your installation. By default, the data returned is for the user\u2019s current area and project only. By default, the data returned...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T18:01:52+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\/application-programming-interface-1\/getvalidmetadata-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/","name":"get_valid_meta_data - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T18:01:52+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/getvalidmetadata-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":"get_valid_meta_data"}]},{"@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\/24258","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=24258"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24258\/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=24258"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}