Service Info: system


Service Description

This service provides a number of system-related operations.

Available Operations

The following operations are available for the system service. You can click on each operation to see detailed information about that operation.

Operation Description
applicationCacheReload Invoke this method to force the system to reload the application metadata cache for the specified application(s). The system may not flush the metadata immediately if the currently loaded metadata is in use by other transactions.
backgroundJobGetInfo Invoke this operation to get the asynchronous task information.
backgroundJobList Invoke this operation to get a list of background jobs.
backgroundJobRegister Invoke this operation to register a background task that is running on the ESP server.
backgroundJobStatus Invoke this operation to get the status of the asynchronous task.
backgroundJobUpdate Invoke this operation to update the status of the specified background job.
bookmarkHistoryAdd Invoke this operation to add a history bookmark
bookmarkHistoryClear Invoke this operation to clear your bookmark history
bookmarkHistoryDelete Invoke this operation to delete a bookmark(s) history
bookmarkHistoryList Invoke this operation to get a list of bookmark history items
getLanguageList Invoke this operation to get list of supported, unsupported or all languages.
getLogFileList Invoke this operation to get a list of log files available for reading.
getLogFileRecords Invoke this operation to get log file lines.
getLogFileStatus Invoke this operation to obtain log file status information.
getSupportedLanguageList Invoke this operation to obtain a list of supported languages.
getSystemCounters Invoke this operation to retrieve the server's runtime counters and diagnostics variables.
harryDismissNotice Invoke this operation to dismiss (acknowledge as seen) one or more notices.
harryGetNotice Invoke this operation to returns information about the specified notice. This will only return the information about the notice if you should have visibility of the notice. If you should have visibility but you have already dismissed the notice then this call will succeed but not return any information, you can use absence of the 'notice' parameter as an indicator that the notice has already been seen and dismissed.
harryGetNoticeCount Invoke this operation to retrieve a list of currently active Harry Hornbill notices for the current user.
harryGetNotices Invoke this operation to retrieve a list of currently active Harry Hornbill notices for the current user.
logMessage Logs a message into the specified log file. This operation is asynchronous and will return immediately.
notifyApp EXPERIMENTAL: Invoke this operation to send a notification message to all users that are assigned the specified application(s). If any user is assigned to more than one specified application, they are only sent a single message.
notifyGroup EXPERIMENTAL: Invoke this operation to send a notification message to all users of the specified group(s). If any user is assigned to more than one specified group, they are only sent a single message.
notifyRole EXPERIMENTAL: Invoke this operation to send a notification message to all users that are assigned the specified role(s). If any user is assigned to more than one specified role, they are only sent a single message.
notifyUser EXPERIMENTAL: Invoke this operation to send a notification message to one or more users. If a user is specified more than once, only one notification message is sent. If an invalid user is specified this will be quietly ignored.
pingCheck Invoke this operation to verify service response. This operation is only intended for use to determine system availability providing a high level of confidence that the service is responding through its layers. Each stage provides a deeper level of checking. It is recommended that you call this operation starting at stage 1, then re-call with the next stage. Successful call confirms that level through the stack is responding correctly. The utility EspPing.exe uses this operation to perform its round trip checks.
releaseNotesGet Invoke this operation to get release notes for a given application or the platform.
sendProductFeedback Operation for sending product feedback to Hornbill's product team
setSupportedLanguage Invoke this operation to set or unset the support for the language.
startReindex Invoke this method to start a reindex for a particular index store.
subscriptionCheck Invoke this operation to retrieve subscription audit information.

Powered by Hornbill, for more information click here. (page served by , .)