add_field_list

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 evadd 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’s) are shown from other fields. UDF’s are handled in a seamless way within the API.

SYNTAX

http://www.myserver.com/evj/ExtraView/ev_api.action?
user_id=username
&password=password OR [&access_token=token-value]
&statevar=add_field_list
[&include_images=1]

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.

RESOLUTION Disposition
CUSTOMER Customer
+SHORT_DESCR Title
ALT_ID Alt ID
+PRODUCT_NAME Product
PRIORITY Priority
+CATEGORY Category
SEVERITY_LEVEL Severity
ASSIGNED_TO Assigned To
OWNER Owner
COMPONENT Component
TEST_CASE_ID Test Case ID
TEST_CASE_LOCATION Test Case Location
PLATFORM Platforms
OS OS
PRIVACY View
*WORKAROUND Workaround
*RELEASE_NOTES Release Notes
+*DESCRIPTION Description

NOTES

  • The general form of each entry returned by the command is:

    <prefix><fieldName><delimiter><fieldTitle><delimiter><parentName>

    where 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:

    ~ means the field is part of a repeating row layout
    * means the field has a display type of textarea or logarea
    % means the field has a display type of user

  • The 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
  • 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.