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.

&username_display=ID | LAST | FIRST

[exclude_data_images=no | yes]

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:

Configuring the XYZ module results in an error


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.

The values returned may not be returned in the same order as the parameters you provide.

The values returned are the NAMES or ID’s of the fields set as parameters.

The =1 in the parameter list is a mechanism to provide a dummy value. The number 1 has no significance.

The optional parameter username_display 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.

When retrieving log area display type fields, such as the COMMENTS field in the above example, there is an optional parameter, all=yes.  When this is set, you will retrieve all the entries for the log area, not just the most recent one.

The optional ev_send_xml will send the response to the command in XML format.

If the data returned includes an image, the data for the image will be base 64 encoded.  However, the optional parameter exclude_data_images will inhibit images embedded within HTML Area fields from being output, if set to a value of yes.

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.