Application consoles API

The Application Consoles API Resource Details dialog box enables you to specify whether or not to call an API and how that API is called.

Permissions cannot be maintained for API resources. An API resource can call a Sterling Order Management System standard API or invoke a service that has been configured.

Note: Although you can create any number of API resources under an Entity, you should create only one list and one detail API.

Table 1. API resource dialog box.
API resource field value descriptions
Control	Description
Invoke a Service	Specifies that a service is invoked in the UI for this resource.
Service Name	Applies only to services. Enabled through the Invoke a Service radio button. Provides a drop-down list of available services that have been previously configured in the Services of the Applications Manager.
Templates	Applies only to services. Enabled through the Invoke a Service radio button. Provides a way for you to add, modify, and delete a list of templates. You can enter an API Name and a Template for each row in the table. This way you can enter templates for all APIs that are called within the service. Important: note that one service should not execute the same API twice because you cannot configure multiple template elements for the same API.
Invoke an API	Specifies that a Sterling Order Management System standard API is invoked in the UI for this resource. When checked, it enables the API Name drop-down list and API Template.
API Name	Applies only to APIs. Enabled through the Invoke an API radio button. Provides a drop-down list of standard or extended APIs available through the Service Definition Framework. If the API you select is backward compatible, the Requires Backward Compatibility checkbox is enabled.
Requires Backward Compatibility	Applies only to APIs that can be invoked in backward compatibility mode. Enables you to specify if the API should run in backward compatibility mode. When checked, Version must also be supplied.
Version	Applies only to APIs running in backward compatibility mode. Provides a drop-down list of the versions for which an API is backward compatible.
Input Namespace	Namespace corresponding to the text box that passes input to a Save API. Applies only to a detail view, as they may have several text boxes that are bound to different XML namespaces. However, only one of the text boxes can pass input to the API.
Output Namespace	The output of the API is saved in this namespace. Namespace is optional, but if it is not specified, it is defaulted to the root node name of the XML under consideration. Therefore, while referring to the output of the API, even if namespace is not specified here, it can be assumed to be the same as the root node name of the output. A namespace is a tag that can be used to identify a specific XML. The Presentation Framework enables you to call multiple APIs and store the outputs in different namespaces. In your JSP or in the input to an API, you can refer to values from any namespace that is available at that point.
Ignore Exception	If this API throws an exception then it is not displayed to the user. This option is not available for API resources that are created directly under an Entity resource.
Skip Automatic Execution	When this option is checked, the API is not called automatically when the view displays. You can then call this API within the JSP using the `callAPI` taglib. This option is not available for API resources that are created directly under an Entity resource.
Call In Rollback-Only Mode	Check this box if you want to call this API in rollback-only mode to roll back the changes made in the database. By default, this checkbox is disabled for all Sterling Order Management System APIs. Note: However, in order to execute this rollback-only operation, a custom action needs to be created. For information about creating custom actions in a screen, refer to the IBM Sterling Order Management: Customizing Console JSP Interface for End-User .
API Type	Specify the type of view from which the API may be invoked. This option is only available for API resources that are created directly under an Entity resource. Such resource types are: List - invokes the API from a list view Detail - invokes the API from a detail view
Input	Provide an XML structure that can be used to pass specific input to the API. You can specify dynamic attributes here.
Template	Provide a template XML here. This template XML is passed to the API through the `YFSEnvironment` class. Although `YFSEnvironment` class supports passing a complete XML or simply an XML file name, you can only provide a complete XML in this field.