API des consoles d'application
La boîte de dialogue Application Consoles API Resource Details vous permet d'indiquer s'il convient ou non d'appeler une API ainsi que la méthode d'appel de cette API.
Aucun droit ne peut être géré pour les ressources d'API. Une ressource API peut appeler une API standard de Sterling™ Order Management System ou invoquer un service qui a été configuré.
| Contrôle | Description |
|---|---|
| Appeler un service | Indique qu'un service est appelé dans l'interface utilisateur pour cette ressource. |
| Nom du service | S'applique uniquement aux services. Cette option est activée via le bouton radio Appeler un service. Elle fournit une liste déroulante des services disponible qui ont déjà été configurés dans les Services d'Applications Manager. |
| Modèles | S'applique uniquement aux services. Cette option est activée via le bouton radio Appeler un service. Elle vous permet d'ajouter, de modifier et de supprimer une liste de modèles. Vous pouvez entrer un nom d'API et un modèle pour chaque ligne de la table. Vous pouvez ainsi entrer des modèles pour toutes les API appelées au sein du service. Important : notez qu'un service ne devrait pas exécuter la même API deux fois car vous ne pouvez pas configurer plusieurs éléments de modèle pour la même API. |
| Appeler une API | Indique qu'une API standard Sterling Order Management System est appelée dans l'interface utilisateur pour cette ressource. Lorsque cette option est sélectionnée, elle active la liste déroulante Nom d'API et le modèle d'API. |
| Nom d'API | S'applique uniquement aux API. Cette option est activée via le bouton radio Appeler une API. Elle fournit une liste déroulante d'API standard ou étendues, disponibles via l'infrastructure de définition de services. Si l'API que vous sélectionnez est compatible en amont, la case Requiert la compatibilité avec les versions antérieures est cochée. |
| Requiert la compatibilité avec les versions antérieures | S'applique uniquement aux API qui peuvent être appelées en mode compatibilité avec les versions antérieures. Cette option vous permet d'indiquer si l'API devrait s'exécuter en mode compatibilité avec les versions antérieures. Si cette case est cochée, la version doit être fournie. |
| Version | S'applique uniquement aux API qui s'exécutent en mode compatibilité avec les versions antérieures. Elle fournit une liste déroulante des versions pour lesquelles une API est compatible en amont. |
| Espace de nom d'entrée | Espace de nom correspondant à la zone de saisie qui transmet l'entrée à une API de sauvegarde. S'applique uniquement à une vue détaillée, étant donné que plusieurs zones de saisie peuvent être liées à différents espaces de nom XML. Toutefois, une seule zone de saisie peut transmettre l'entrée à l'API. |
| Espace de nom de sortie | La sortie de l'API est sauvegardée dans cet espace de nom. L'espace de nom est facultatif, mais s'il n'est pas spécifié, il prend par défaut le nom du noeud racine du fichier XML concerné. En conséquence, même si l'espace de nom n'est pas spécifié lors du renvoi vers le résultat de l'API, on peut considérer qu'il est identique au nom du noeud racine de la sortie. Un espace de nom est une balise pouvant servir à identifier un fichier XML spécifique. Presentation Framework vous permet d'appeler plusieurs API et d'enregistrer les résultats dans des espaces de nom différents. Dans le fichier JSP ou dans les données d'entrée d'une API, vous pouvez faire référence aux valeurs provenant de tout espace de nom disponible à ce moment. |
| Ignorer l'exception | Si cette API émet une exception, elle ne s'affiche pas à l'utilisateur. Cette option n'est pas disponible pour les ressources d'API créées directement sous une ressource d'entité. |
| Ignorer l'exécution automatique | Lorsque cette option est sélectionnée, l'API n'est pas appelée automatiquement
lorsque la vue s'affiche. Vous pouvez appeler cette API par la suite dans le fichier JSP
à l'aide de la bibliothèque de balises callAPI. Cette option n'est pas disponible pour les ressources d'API créées directement sous une ressource d'entité. |
| Appeler mode retour uniquement | Cochez cette case si vous souhaitez appeler cette API en mode retour
uniquement afin d'annuler les changements apportés à la base de données. Par défaut, cette case est désactivée pour toutes les API Sterling Order Management System . Remarque: Toutefois, pour exécuter cette opération d'annulation seule, une action personnalisée doit être créée. Pour plus d'informations sur la création d'actions personnalisées dans un écran, voir IBM Sterling Order Management: Personnalisation de l'interface JSP de la console pour l'utilisateur final .
|
| Type d'API | Indiquez le type de vue à partir de laquelle l'API peut être appelée. Cette option n'est disponible que pour les ressources d'API créées directement sous une ressource d'entité. Ces types de ressource sont les suivants :
|
| Entrée | Fournissez une structure XML pouvant être utilisée pour transmettre une entrée spécifique à l'API. Vous pouvez spécifier ici des attributs dynamiques. |
| Modèle | Fournissez un modèle de fichier XML ici. Ce modèle de fichier XML est transmis
à l'API via la classe YFSEnvironment.Bien que la classe |