Dynamic Time Terms

API Programming Guide › CA User Activity Reporting Module API Examples › Query and Report Viewer Calls › Query Specifications › Dynamic Time Terms

Dynamic Time Terms

Use dynamic time params terms to specify the time ranges to which a query applies by adding them to certain result conditions specifications.

The available dynamic time params terms are as follows:

Term	Description
now	The current time
start of day	Start of the current day
weekday <number>	Numbered day of the week: Sunday 0 Monday 1 Tuesday 2 Wednesday 3 Thursday 4 Friday 5 Saturday 6
start of month	Start of the current month
start of year	Start of the current year
<number> seconds	Number of seconds
<number> minutes	Number of minutes
<number> hours	Number of hours
<number> days	Number of days

You can specify result conditions for a Query Definition or Report Definition. In this case any time specifications you add to the call override the values specified in the base Query or Report.

In both cases, any values not specified in the URL remain unchanged.

Dynamic Time Terms Specification Example

This example is show with the params terms expanded for clarity.

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getQueryViewer&objectId=Subscription/panels/System_Event_Count_By_Event_Action
<Params>
  <Param id="ARG_start" val="'now', '-12 hours'"/>
  <Param id="ARG_stop" val="'now'"/>
</Params>

The "ARG_start" values 'now' and '-12 hours' set the query to start 12 hours ago.

The "ARG_stop" value 'now' sets the query to end at the current time, so this query would gather data only from the last 12 hours.

More information

Result Condition Specifications

runQuery