Service Info: time
Service Description
This service provides the operations needed to support time related functions for service level management.
Available Operations
The following operations are available for the time service. You can click on each operation to see detailed information about that operation.
| Operation | Description |
|---|---|
| getDefaultWorkingTime | Invoke this operation to retrieve the information about the default business hours for each day of the week to the nearest half-hour, Server Time Zone, Default SLA and Holiday Exclusions. |
| getLocalTime | Invoke this operation to obtain the local time for the specified time zone(s). |
| getServerTimezoneInfo | Invoke this operation to retrieve the information about the server's default timezone. |
| getTimezoneDetails | Invoke this operation to obtain the details that relate to the specified timezone. |
| getTimezoneList | The server maintains a list of timezones and relevant information about those timezones. Invoke this operation to get a list of timezones known to the Hornbill ESP server. |
| getTimezoneOffset | Invoke this operation to obtain the currently active offset from UTC for the specified timezone. |
| localTimeToUtcTime | Invoke this operation to obtain a UTC time from the specified local time. |
| scheduledJobChangeOwner | Invoke this method to change the owner of the scheduled job (for admin use only). |
| scheduledJobCreate | Invoke this method to create a scheduled job. |
| scheduledJobDelete | Invoke this method to delete the scheduled job. |
| scheduledJobGetInfo | Invoke this method to get one or more scheduled job properties. |
| scheduledJobGetList | Invoke this operation to get a list of scheduled jobs you have defined |
| scheduledJobGetLog | Return the log for the sepcfiedi schedule. Returns in cronological descending order (newest entry first). |
| scheduledJobGetOwnedJobs | Invoke this operation to get a list of scheduled jobs for a given user or all scheduled jobs if no owner received (for admin use only). |
| scheduledJobUpdate | Invoke this method to set one or more scheduled job properties. |
| slcCalculateDays | Given an array of service level calendars, start and end times, calculates the elapsed working days between the two times specified. If tStart > tEnd then the returned period will be a negative number. There will be one response for each working period basis. A working day is defined as a day in the relevant calendar that has at least one timeslot active and is not an excluded day. The first day is a partial day if the first active timeslot starts before the start time, and the last day is a partial day if the last active timeslot ends after the end time. |
| slcCalculatePeriod | Given a service level calendar, start and end time, calculate the elapsed working time in seconds between the two times specified. If tStart > tEnd then the returned period will be a negative number. |
| slcCalculateTime | Given a start time and elapsed working time period, calculate the time in the future or the past. If the 'workingPeriod' parameter is a negative value then a time calculation will work on a reverse timeline and the resultant time will be a time in the past relative to the startTime. |
| slcCreate | This operation is used to create a new Service Level Calendar (SLC). The Hornbill ESP server uses these SLC's to perform time calculations based on working time. Working time is defined by setting one or more timeslots in a given 24 hour period. Working times are defined in a resolution of 15-minute periods - that is, there are 96 timeslots, each representing 15 minutes worth of time in a 24 hour period. |
| slcDelete | This operation is used to delete an existing service level calendar. |
| slcGet | Invoke this operation to get information about the specified service level calendar. |
| slcList | This operation is used to get a list of service level calendars defined on the system. |
| slcMultiCalculatePeriod | Given an array of service level calendars, start and end times, calculate the elapsed working time in seconds between the two times specified. If tStart > tEnd then the returned period will be a negative number. There will be one response for each working period basis. |
| slcUpdate | This operation is used to update an existing service level calendar. The configuration of the SLC specified will be overwritten with the new settings provided. |
| timerCreate | This operation is used to create a timer instance. Events can also be created for the timer, where the flowcode event "OnTimerEvent" is invoked at the specified timer condition. Any number of workingTimerEvents or elapsedTimerEvents can be created for the given timer. |
| timerDelete | This operation is used to delete timer instance. |
| timerDeleteGroup | This operation is used to delete a group of timer instances. |
| timerEventCreate | This operation is used to create a timer event(s). Events can be created for the timer, where the flowcode event "OnTimerEvent" is invoked at the specified timer condition. Any number of workingTimerEvents or elapsedTimerEvents can be created for the given timer. |
| timerEventDelete | This operation is used to delete timer event. |
| timerEventDeleteGroup | This operation is used to delete a group of timer instances. |
| timerEventQuery | This operation is used to query the timer event information. |
| timerEventQueryGroup | This operation is used to query the timer event(s). |
| timerPause | This operation is used to pause the specified timer, where the flowcode event "OnTimerPause" is invoked. |
| timerQuery | This operation is used to query the state of the specified timer. |
| timerQueryGroup | This operation is used to query the list of timer(s) belonging to a group. |
| timerResume | This operation is used to resume a timer that is currently paused, where the flowcode event "OnTimerResume" is invoked. |
| utcTimeToLocalTime | Invoke this operation to obtain a local time from the specified time. |