Product Documentation

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
&statevar=get_valid_meta_data
&fields=field_x
&user_info=x
&disabled_values=Y
&all=Y
[&access_token=token-value]

NOTES

This function can return a significant amount of data, depending on your installation.

By default, the data returned is for the user’s current area and project only.

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.

The previous two default conditions can be overridden, by using the optional parameter all=Y as part of the call.

The optional parameter fields can be used to refine the metadata returned to a single, or to a list of fields. For example, fields=CUST_LIST will return the metadata associated with the CUST_LIST 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.

The optional parameter disabled_values wlil return all the users, including those that are disabled, within the output to the command.

The optional parameter user_info has three possible functions:

1. When no parameter is specified, the command works as documented in the other sections of this page
2. When the parameter has a value of N then no user information is generated in the return of the call
3. When the parameter has a value of Y then one set of generic information is returned, with SECURITY_USER_ID being used as the field ID.

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.

The result of the function is in the form:

field_name:meta_data_name:meta_data_title

where the delimiter : is the system delimiter stored in the behavior setting named DEFAULT_TEXT_REPORT_DELIMITER.

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

A small sample of data returned is shown below - note the delimiter in this case is the | character: