API details screen

This screen displays detailed information about an API.

The current status (good, alert, or warning) of the API is represented by the icon next to the API Name field.

By default, the graph displays the minimum, maximum, and average response time (in seconds) over the last 4 hours. The average response time threshold appears on the graph as a horizontal red line.

To view the number of invocations for that API over the last 4 hours, select the # Of Invocations option.

Some standard Sterling™ Order Management System Application Platform APIs also record API-specific statistics. For example, the createOrder API records the number of orders and order lines created during each API invocation. If the API that the API Detail screen was opened for contains API-specific statistics, they appear as check boxes under the API Specific Statistics option. To view the API-specific statistics in the graph, select the API Specific Statistics option and then select the appropriate checkboxes next to the statistics you would like to see in the graph. It is possible to graph multiple statistics at the same time by checking multiple checkboxes.

Table 1. API details screen, primary info
Fields	Description
API Name	The name of the API.
Trace Status	The current trace status, or Off if the API is not currently being traced.
Actions	Description
Change Trace Status	Select this to change the tracing status of an API. Select a new trace status in the dialog, and click OK. To turn tracing off, select Off in the dialog.
Change Threshold	When the Min, Max, and Average Response Time option is selected on the API Detail screen, the currently set response time threshold appears under the graph. To change the threshold, click this button, enter a new threshold value in the dialog, and click Apply.

Table 2. API details screen, response time by JVM
Fields	Description
Response Time By JVM The JVMs listed here are only the application server JVMs that called this API. This information can be used to determine if the API response time is consistent across all JVMs. If the response time is not consistent, there might be an issue with a specific JVM.
Host	The host name.
Server Name	The server name.
Average	The average response time in seconds.
Minimum	The minimum response time in seconds.
Maximum	The maximum response time in seconds.
Actions	Description
View Details	To open the Application Hosts Summary Screen for a JVM in this list, select the appropriate JVM and click this button.

Table 3. API details screen, implemented user exits
Actions	Description
Implemented User Exits Each implemented user exit appears as a radio button above the user exit graph. The statistics for each user exit can be viewed by changing the user exit radio button selections. By default, the user exit graph displays the minimum, maximum, and average response time (in seconds) for the user exit over the last 4 hours. The number of invocations for that user exit over the last 4 hours can also be viewed by selecting the # Of Invocations option under the user exit graph.
Change Trace Status	Select this to change the tracing status of a user exit. Select a new trace status in the dialog, and click OK. To turn tracing off, select Off in the dialog.