Integration Server 10.7 | Built-In Services Reference Guide | Alert Folder | Summary of Elements in this Folder | pub.alert:fetchAll
 
pub.alert:fetchAll
WmPublic. Fetches all alerts in the system, read and unread, or a subset of alerts that meet the filter criteria.
Input Parameters
filter
Document. Optional. To fetch a subset of alerts, specify the criteria using the following keys:
Key
Description
startTime
Long. Optional. Start of the time interval in which alerts are emitted. Specify the value in the UNIX epoch format in milliseconds.
endTime
Long. Optional. End of the time interval in which alerts are emitted. Specify the value in the UNIX epoch format in milliseconds.
severities
String[]. Optional. List of severities.
channels
Object[]. Optional. List of channel identifiers.
user
String. Optional. The Integration Server user who triggered the alerts or Administrator for alerts emitted by the server. For example, specify Administrator for Password Management alerts.
keyword
String. Optional. A keyword that identifies the alerts.
sortOrder
String. Optional. The order in which the fetched alerts are sorted. Select ASC or DESC. The default is DESC.
sortBy
String. Optional. The criteria to sort the fetched alerts. Select one of the following options:
*channel
*severity
*subject
*timestamp
The default is timestamp.
pageSize
Integer. The number of notifications on a page.
pageNumber
Integer. In a paginated list of notifications, the page where Integration Server loads the notifications.
Note:
Page number starts with 0.
Output Parameters
alerts
Document List. A list of the alerts retrieved by the service. Each alert has the following details:
Key
Description
id
Long. Alert identifier.
ts
Long.
Date and time when the alert is generated, in the UNIX epoch time format.
serverId
String. IP address of the host where Integration Server is running.
memberName
String. Member name of the machine that hosts Integration Server in a cluster.
user
String. Integration Server user who triggered the alert.
channelId
Integer. Channel identifier for the alert.
channel
String. Channel for the alert.
severityId
Integer. Severity identifier of the alert.
severity
String. Severity of the alert.
subject
String. Subject of the alert message.
contentType
String. Text that identifies the type of content in the alert such as text/plain and text/html.
content
String. Content of the alert.
Usage Notes
To fetch all read and unread alerts in the system, do not specify the filter criteria as inputs.
The number of notifications on a page is identified by pageSize and the current page is identified by pageNumber.