API de consoles do aplicativo

A caixa de diálogo Detalhes do Recurso de API de Consoles do Aplicativo permite especificar se uma chamada de API deve ser feita ou não e como essa API é chamada.

As permissões não podem ser mantidas para recursos da API. Um recurso de API pode chamar uma API padrão do Sterling™ Order Management System ou invocar um serviço que tenha sido configurado.

Nota: embora seja possível criar qualquer número de recursos de API em uma Entidade, deve-se criar apenas uma lista e uma API de detalhes

Tabela 1. caixa de diálogo do recurso da API.
Descrições de valor do campo de recursos da API
Controle	Descrição
Chamar um Serviço	Especifica que um serviço é chamado na IU para este recurso.
Nome do Serviço	Aplica-se apenas a serviços. Ativado por meio do botão de opções Chamar um Serviço. Fornece uma lista suspensa de serviços disponíveis que foram anteriormente configurados nos Serviços do Gerenciador de Aplicativos.
Modelos	Aplica-se apenas a serviços. Ativado por meio do botão de opções Chamar um Serviço. Fornece uma maneira para incluir, modificar e excluir uma lista de modelos. É possível inserir um Nome de API e um Modelo para cada linha na tabela. Dessa forma, é possível inserir modelos para todas as APIs que são chamadas no serviço. Importante: Observe que um serviço não deve executar a mesma API duas vezes porque não é possível configurar diversos elementos de modelo para a mesma API.
Chamar uma API	Especifica que uma API padrão do Sterling Order Management System é chamada na IU para esse recurso Quando selecionado, ativa a lista suspensa Nome da API e Modelo de API.
Nome da API	Aplica-se apenas a APIs. Ativado por meio do botão de opções Chamar uma API. Fornece uma lista suspensa de APIs padrão ou estendidas disponíveis por meio da Estrutura de Definição de Serviço. Se a API que você selecionar for compatível com versões anteriores, a caixa de seleção Requer Compatibilidade com Versões Anteriores é ativada.
Requer Compatibilidade com Versões Anteriores	Aplica-se apenas às APIs que puderem ser chamadas no modo de compatibilidade com versões anteriores. Permite especificar se a API deve ser executada no modo de compatibilidade com versões anteriores. Quando selecionado, a Versão também deverá ser fornecida.
Version	Aplica-se apenas às APIs em execução no modo de compatibilidade com versões anteriores. Fornece uma lista suspensa de versões para as quais uma API é compatível com versões anteriores.
Namespace de entrada	O namespace correspondente à caixa de texto que transmite a entrada para uma API de Salvar. Aplica-se apenas a uma visualização de detalhes, já que elas podem ter várias caixas de texto que são ligadas a diferentes namespaces XML. Contudo, apenas uma das caixas de texto pode transmitir entrada para a API.
Namespace de saída	A saída da API é salva neste namespace. O namespace é opcional, mas se ele não for especificado, ele será padronizado para o nome do nó raiz do XML sob consideração. Portanto, ao se referir à saída da API, mesmo se o namespace não for especificado aqui, ele poderá ser assumido como o mesmo do nome do nó raiz da saída. Um namespace é uma tag que pode ser utilizada para identificar um XML específico. O Presentation Framework permite chamar diversas APIs e armazenar as saídas em diferentes namespaces. Em sua JSP ou na entrada para uma API, é possível consultar valores de qualquer namespace que esteja disponível nesse ponto.
Ignorar Exceção	Se essa API emitir uma exceção, ela não será exibida para o usuário. Essa opção não está disponível para recursos da API que forem criados diretamente sob um recurso de Entidade.
Ignorar Execução Automática	Quando esta opção estiver marcada, a API não será chamada automaticamente quando a visualização for exibida. Em seguida, é possível chamar esta API dentro da JSP usando a taglib `callAPI`. Essa opção não está disponível para recursos da API que são criados diretamente em um recurso de Entidade.
Chamar Modo Apenas Retroceder	Selecione esta caixa se desejar chamar essa API no modo somente retrocesso para retroceder as mudanças feitas no banco de dados. Por padrão, essa caixa de seleção é desativada para todas as APIs do Sterling Order Management System Nota: no entanto, para executar essa operação somente de recuperação, uma ação customizada precisa ser criada. Para obter informações sobre como criar ações customizadas em uma tela, consulte a IBM Sterling Order Management: Customizando Interface JSP do Console para Usuário Final .
Tipo de API	Especifique o tipo de visualização a partir da qual a API pode ser chamada. Esta opção está disponível apenas para recursos da API que são criados diretamente em um recurso de Entidade. Esses tipos de recursos são: Lista – chama a API a partir de uma visualização de lista Detalhe – chama a API a partir de uma visualização de detalhes
Entrada	Forneça uma estrutura XML que possa ser utilizada para transmitir entrada específica para a API. É possível especificar atributos dinâmicos aqui.
Modelo	Forneça um XML de modelo aqui. Este XML de modelo é transmitido para a API através da classe `YFSEnvironment`. Embora a classe `YFSEnvironment` suporte a transmissão de um XML completo ou apenas de um nome de arquivo XML, é possível fornecer apenas o XML completo neste campo.