Guida alla programmazione API › Esempi di API di CA User Activity Reporting Module › GetObject

GetObject

Questo file di comando consente di recuperare vari tipi di informazioni. Può essere utilizzato per recuperare un elenco di query, rapporti o parametri globali, nonché la Grammatica evento comune (CEG, Common Event Grammar). Il comando getObject si serve di un qualificatore o argomento denominato "type" per determinare i dati da restituire al chiamante, come illustrato nell'esempio seguente:

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

L'elenco seguente fornisce un riepilogo dei tipi di dati restituiti utilizzando le varianti di questo comando:

getQueryList

Restituisce una stringa XML che mostra tutte le query all'interno di CA User Activity Reporting Module. getQueryList supporta molti parametri di filtraggio che consentono di selezionare e includere nelle chiamate all'API i nomi delle query corretti.

getReportList

Restituisce una stringa XML che mostra tutti rapporti all'interno di CA User Activity Reporting Module. getReportList supporta molti parametri di filtraggio che consentono di selezionare e includere nelle chiamate all'API i nomi dei rapporti corretti.

getDataModel

Restituisce la CEG in formato XML. Selezionare i termini della CEG da includere nel filtro delle chiamate all'API.

getIdealModel

Restituisce i modelli ideali definiti nella CEG. Selezionare termini generali per le aree dei prodotti da includere nel filtro delle chiamate all'API.

getIncidentModel

Restituisce i campi CEG disponibili utilizzati negli incidenti generati dalla correlazione eventi.

Getcombinedmodel

Restituisce la grammatica evento comune (CEG) in formato XML per i campi Evento e Incidente. Selezionare i termini della CEG da includere nel filtro delle chiamate all'API.

getGlobalSettings

Restituisce le impostazioni globali del server CA User Activity Reporting Module sul quale viene eseguito il comando. È possibile risalire al filtro delle query di CA User Activity Reporting Module già attivo in modo da poter creare efficaci filtri delle chiamate all'API.

getELMServers

Restituisce un elenco dei server CA User Activity Reporting Module. Questo comando è utile negli ambienti federati, poiché consente di individuare i server controllanti o controllati che si desidera interrogare.

getTimeZones

Consente di ricavare un elenco dei fusi orari utilizzabili come argomenti durante l'esecuzione delle query.

getVersion

Restituisce la versione di ELM, che corrisponde alla versione delle API, utile per scopi diagnostici.

getObjectDefinition

Restituisce i metadati di un rapporto o una query in base all'ID di un oggetto specifico. I metadati corrispondono ai dati di formattazione che determinano la modalità di presentazione di un rapporto o una query. Utilizzare i metadati quando si esegue la chiamata runQuery per acquisire i dati CA User Activity Reporting Module per un'applicazione che non consente di integrare il visualizzatore di query o rapporti in modo diretto.

getQueryViewer

Restituisce il codice HTML contenente il componente visualizzatore di query precaricato con una query specificata.

getReportViewer

Restituisce il codice HTML contenente il componente visualizzatore di report precaricato con un rapporto specificato.

Ad eccezione di getQueryViewer e getReportViewer, tutti i comandi getObject restituiscono un errore se nel comando API non sono presenti sessioni autenticate:

Risposta di errore:
<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>false</Value>
	<Description> Utente non connesso</Description>
</Result>

Nell'esempio precedente, il valore del risultato "false" indica un errore e la descrizione ne specifica il motivo, in questo caso "Utente non connesso".

Ulteriori informazioni:

Chiamate al visualizzatore di query e rapporti