Manuel de programmation de l'API › Exemples API CA Enterprise Log Manager › GetObject

GetObject

Ce fichier de commande permet de récupérer divers types d'informations. Utilisez-le pour récupérer une liste de requêtes, de rapports ou de paramètres globaux, ou encore la grammaire commune aux événements (CEG). La commande getObject utilise un qualificateur ou un argument nommé "type" pour déterminer le type des données à renvoyer à l'appelant comme le montre cet exemple :

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=type&tag=tagname1&tag=tagnamen&taglogic=OR|AND

La liste suivante répertorie les types de données renvoyées selon les variations de cette commande :

getQueryList

Renvoie une chaîne XML contenant toutes les requêtes dans CA Enterprise Log Manager. getQueryList prend en charge de nombreux paramètres de filtrage qui vous permettent de sélectionner et d'inclure des noms de requête dans vos appels API.

getReportList

Renvoie une chaîne XML contenant tous les rapports dans CA Enterprise Log Manager. getReportList prend en charge de nombreux paramètres de filtrage qui vous permettent de sélectionner et d'inclure des noms de rapport dans vos appels API.

getDataModel

Renvoie la grammaire commune aux événements (CEG) au format XML. Cela vous permet de sélectionner les termes CEG à inclure dans le filtrage des appels API.

getIdealModel

Renvoie les modèles idéaux définis dans la CEG. Cela vous permet de sélectionner les termes de zone de produit à inclure dans le filtrage des appels API.

getIncidentModel

Renvoie les champs CEG disponibles utilisés dans les incidents générés par la corrélation d'événements.

getCombinedModel

Renvoie la grammaire commune aux événements (CEG) au format XML pour les champs d'événement et d'incident. Cela vous permet de sélectionner les termes CEG à inclure dans le filtrage des appels API.

getGlobalSettings

Renvoie les paramètres globaux pour le serveur CA Enterprise Log Manager sur lequel la commande est exécutée. Ces paramètres vous indiquent quel filtrage est activé pour les requêtes CA Enterprise Log Manager afin de créer des filtres d'appels API efficaces.

getELMServers

Renvoie une liste de serveurs CA Enterprise Log Manager. Cette commande est utile dans un environnement fédéré, car elle vous permet de cibler les serveurs parents ou enfants à interroger.

getTimeZones

Extrait une liste de fuseaux horaires pouvant être utilisés comme arguments dans les requêtes en cours d'exécution.

getVersion

Renvoie la version ELM, identique à celle des API et utile pour établir des diagnostics.

getObjectDefinition

Renvoie les métadonnées pour un rapport ou une requête selon l'ID d'objet indiqué. Les métadonnées correspondent aux données de formatage qui définissent la présentation d'un rapport ou d'une requête. Utilisez ces métadonnées lorsque vous devez utiliser l'appel runQuery pour obtenir les données CA Enterprise Log Manager d'une application qui ne peut pas intégrer directement une visionneuse de requêtes ou de rapports.

getQueryViewer

Affiche la page HTML contenant la visionneuse de requêtes avec une requête préchargée.

getReportViewer

Affiche la page HTML contenant la visionneuse de rapports avec un rapport préchargé.

Toutes les commandes GetObject, à l'exception de getQueryViewer et getReportViewer, produisent une erreur si la commande API ne comporte aucune session authentifiée :

Réponse en cas d'échec :
<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>false</Value>
	<Description> User is not logged in</Description>
</Result>

Dans l'exemple précédent, la valeur du résultat est "false" ce qui indique un échec de la commande. La raison est indiquée dans la description, dans ce cas : "User is not logged in" (L'utilisateur n'est pas connecté).

Informations complémentaires :

Appels de la visionneuse de requêtes et de rapports