showServerErrorMessage

Method Type

JavaScript

Description

Shows an error message in a pop-up when you call an API or make an Ajax call.

Parameters

The method input is an object with these parameters, and a callback function.

Field NameDefinition

title

Function:
Specifies a title for the error message.
Type
string
Accepted Values:
One line of text that can have spaces.

value

Function:
Specifies the name of an object variable that has error information.
Type
object
Accepted Values:
A name of your object variable.

Output

A result object that gives the status, data, and error details.

Field NameDefinition

isSuccess

Function:
Specifies whether a pop-up shows when the method completes successfully.
Type
bool
Accepted Values:
  • True - The method was successful.
  • False - The method was not successful.

data

Function:
Holds an empty object.

error

Function:
Specifies an error message if an error occurs.
Type
string
Accepted Values:
The contents of an error message.

Example

function InvokeAPI (jsonData, header)
  {       
  var apiURL = 'http://...';
  $.ajax
     ({
     headers: header,
     type: 'POST',
     url: apiURL,
     dataType: 'json',
     async: false,
     cache: false,
     contentType: "application/json",
     Data: JSON.stringify (jsonData),
     success: function (data)
        {      
        alert('success');
        },
     error: function (jqXHR, textStatus, errorThrown) 
        {
        var errorObj = { 'jqXHR': jqXHR, 'textStatus': textStatus, 'errorThrown': errorThrown };
        var options = {value: errorObj, title:'Error2'};
        eFormHelper.showServerErrorMessage (options, function(response)
          {
          });
        }      
     });  
  }

Supported Versions

AgilePoint NX v6.0 SP1​ Software Update 1 Hotfix 3 and higher

Other Examples

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.