应用程序控制台 API

“应用程序控制台 API 资源详细信息”对话框使您可指定是否调用 API 以及如何调用该 API。

无法维护 API 资源的许可权。 API 资源可以调用 Sterling™ Order Management标准 API 或调用已配置的服务。

注: 虽然可以在实体下创建任意数量的 API 资源,但 应该 仅创建 一个 列表一个 详细信息 API
表 1. API 资源对话框

“API 资源”字段值描述

控制 描述
调用服务 指定在 UI 中为此资源调用服务。
服务名称 仅适用于服务。 通过“调用服务”单选按钮启用。 提供先前已在 Applications Manager 的服务中配置的可用服务下拉列表。
模板 仅适用于服务。 通过“调用服务”单选按钮启用。 为您提供了添加、修改和删除模板列表的方法。 您可以为表中各行输入一个 API 名称和模板。 通过这种方法,您可以为服务内调用的所有 API 输入模板。

要点:请注意,一个服务不应执行相同的 API 两次,因为您无法为相同的 API 配置多个模板元素。

调用 API 指定在 UI 中为此资源调用 Sterling Order Management System 标准 API。 选中该字段后,它会启用 API 名称下拉列表和 API 模板。
API 名称 仅适用于 API。 通过“调用 API”单选按钮启用。 提供了可通过“服务定义框架”提供的标准或扩展 API 的下拉列表。 如果您所选的 API 可向后兼容,那么会启用“需要向后兼容性”复选框。
要求向后兼容性 仅应用于可以向后兼容性模式调用的 API。 使您可指定 API 是否应以向后兼容性模式运行。 选中后,还必须提供版本。
版本 仅适用于以向后兼容性模式运行的 API。 提供了 API 为向后兼容的版本的下拉列表。
输入名称空间 与将输入传递到保存 API 的文本框相对应的名称空间。 仅适用于详细信息视图,因为它们可能具有多个绑定到不同 XML 名称空间的文本框。 但是,这些文本框中只有一个可以将输入传递到 API。
输出名称空间 API 的输出会保存在此名称空间中。 名称空间是可选的,但如果未指定名称空间,那么会缺省设置为当前 XML 的根节点名称。 因此,当引用 API 输出时,即使此处未指定名称空间,也会将其假定为与输出的根节点名称相同。

名称空间是可用于标识特定 XML 的标记。 Presentation Framework 允许您调用多个 API,并将输出存储在不同的名称空间中。 在 JSP 中或在 API 的输入中,可以引用来自该点可用的任何名称空间的值。

忽略异常 如果该 API 抛出异常,那么不会向用户显示。 此选项可用于直接在实体资源下创建的 API 资源。
跳过自动执行 选中该选项后,显示视图时不会自动调用 API。 您可以使用 callAPI 标记库在 JSP 内调用此 API。 此选项不可用于直接在实体资源下创建的 API 资源。
调入仅限回滚模式 如果您要以仅限回滚模式调用此 API 来回滚在数据库中进行的更改,请选中此框。

缺省情况下,将对所有 Sterling Order Management System API 禁用此复选框。

注: 但是,要执行此仅回滚操作,需要创建定制操作。 有关在屏幕中创建定制操作的信息,请参阅 IBM Sterling Order Management: Customizing Console JSP Interface for End-User
API 类型 指定可能从中调用 API 的视图的类型。 此选项只能用于直接在实体资源下创建的 API 资源。 此类资源类型为:
  • 列表 - 从列表视图中调用 API
  • 详细信息 - 从详细信息视图中调用 API
输入 提供可用于将特定输入传递到 API 的 XML 结构。 您可以在此处指定动态属性。
模板 在此处提供模板 XML。 此模板 XML 通过 YFSEnvironment 类传递到 API。

虽然 YFSEnvironment 类支持传递一个完整的 XML 或仅仅一个 XML 文件名,但是您只能在该字段中提供一个完整的 XML。