Manuel de programmation de l'API › Exemples API CA User Activity Reporting Module › GetObject › getObjectDefinition

getObjectDefinition

Utilisez la commande getObjectDefinition pour afficher les données de formatage et de disposition associées à une requête ou un rapport au format XML. Vous pouvez afficher les données de formatage dans les rapports existants pour créer un formatage personnalisé, surtout si vous souhaitez utiliser la commande runQuery. La commande getObjectDefinition vous permet également de renvoyer des données portant sur les rapports ou les requêtes d'abonnement et définis par l'utilisateur.

Exemple de commande getObjectDefinition

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getObjectDefinition&objectId=Subscription/panels/Unclassified_Event_Trend

Renvoie le code XML suivant :

?xml version="1.0" encoding="UTF-8" ?> 
<Result>
	<Value>true</Value> 
	<Description>Get Object Successful. Type [getObjectDefinition]</Description> 
	<Panel id="Subscription/panels/Unclassified_Event_Trend" name="Unclassified Event Trend" shortname="Trend" subscription="true" version="12.0.46.5">
		<Description>Provides Trending for unclassified event activity</Description> 
		<Tags>
			<Tag name="Unclassified Event" /> 
  			<Tag name="Unknown Category" /> 
		</Tags>
  		<Params /> 
		<Query>

Cet exemple montre les données de formatage pour la requête Unclassified Event Trend (Tendance de l'événement non classé). Le paramètre "objectId" dans l'appel spécifie le formatage à afficher selon la requête ou le rapport. Dans ce cas, il s'agit de la requête Unclassified Event Trend dans le dossier de requêtes Subscription (Abonnement).

Informations complémentaires :

runQuery