Alerts

8 min

Ivanti EPMM’s Event Center enables administrators to connect events to specific alerts. The following events are recognized:

International Roaming Event

Threshold Reached Event

SIM Changed Event

Storage Size Exceeded Event

System Event

Policy Violations Event

This API can retrieve alerts generated by an above named event.

Alerts include a variety of characteristics, such as severity, lifecycle status, and read/unread status. Alert Lifecycle statuses are defined as follows:

Created: the conditions for generating the alert have been met.

Processed: the alert has been generated.

Dispatched: the alert has been sent.

Dispatch Pending: alert is ready for dispatch.

Dispatching: dispatch is in progress.

Dispatched: dispatch has been completed successfully.

Dispatch Failed: dispatch failed. Get All Alerts This API returns all alerts. You can filter the alerts by their read/unread status.

Get All Alerts

This API returns all alerts. You can filter the alerts by their read/unread status.

Examples:

Get all alerts:

https://<Ivanti EPMM>/api/v1/alerts

Get all alerts that have not been read:

https://<Ivanti EPMM>/api/v1/alerts?isRead=false

URI: https:///api/v1/alerts	Returns list of all alerts.
Http Method:	GET
Format:	xml, json
Request:
isRead	Filter by the read status of the alert. True returns all alerts that are marked read. False returns all the alerts that are marked unread.

Response Status Code:
‘404 – No Data Found’	There is no data.
‘200 – OK’	Data is present and the response is returned.
Response:
<alertWebServiceResponse>
<messages>
<message>1 alert(s) returned</message>	Status Message. Alert count is shown if the method execution is successful. A descriptive error message is shown if the method execution failed.
</messages>
<alerts>
<alert id=”5”>	Internal database ID uniquely identifies alert.
<deviceUuid>6482dce2-ea75-400a-9f2c-d67766d942cf</deviceUuid>
<dispatchDeviceUuid>6482dce2-ea75-400a-9f2c-d67766d942cf</dispatchDeviceUuid>
<userUuid>asdasd-34sd-234sdf-sfsdfd</userUuid>	uuid of the user.
<labelId>163</labelId>	The internal id of the label that triggered the alert. .
<eventSubscriptionName>m1</eventSubscriptionName>
<alertDate>2010-05-01T01:02:00+00:00</alertDate>
<alertText>WARNING::Memory size exceeded 1% for Phone #: 14085551212 (miadmin), Total Memory Size: 154.86MB, Free Memory Size: 133.59MB</alertText>	Alert content.
<isActive>false</isActive>	true -- the alert is unread. false -- the alert is read.
<retries>2</retries>	Number of attempts that have been made to send this alert.
<updateBy>alertprocessor</updateBy>	Name of user/system component which updated this alert.
<updatedAt>2010-04-30T01:04:00+00:00</updatedAt>	The time at which this alert record was last modified.
<userName>miadmin</userName>	Recipient user name.
<alertDefnname>MEMORY_SIZE_EXCEEDED_ALERT</alertDefnname>	Alert type: INTERNATIONAL_ROAMING_ALERT THRESHOLD_REACHED_ALERT SIM_CHANGED_ALERT MEMORY_SIZE_EXCEEDED_ALERT SYSTEM_ALERT POLICY_VIOLATIONS_ALERT
<severity>WARNING</severity>	Alert severity: INFORMATION WARNING CRITICAL
<transport>EMAIL</transport>	Means by which alert is communicated: EMAIL SMS APNS (iPhone only)
<status>DISPATCHED</status>	Alert dispatch status: CREATED PROCESSED DISPATCH_PENDING DISPATCHING DISPATCHED DISPATCH_FAILED
<isAlertRead>true</isAlertRead>	Not used. The isActive field indicates whether the alert is read or unread.
</alert>
</alerts>
</alertWebServiceResponse>

Get All Alerts for Phone Number

This API returns all alerts for a single device phone number. You can further filter the alerts by their read/unread status.

The fields in the response are the same as the fields in the Get All Alerts Response. However, the set of alerts is limited to alerts for the phone number specified in the request.

Examples:

Get all alerts for a phone number:

https://<Ivanti EPMM>/api/v1/alerts/phones/6505551212

Get all alerts for a phone number that have been read:

https://<Ivanti EPMM>/api/v1/alerts/phones/6505551212?isRead=true

URI: https:///api/v1/alerts/phones/	Returns list of all alerts for input phone number.
Http Method:	GET
Format:	xml, json
Request:
phoneNumber	Required. Phone number.
isRead	Filter by the read status of the alert. True returns all alerts which are marked read. False returns all the alerts which are marked unread.

Response Status Code:
‘404 – No Data Found’	There is no data.
‘200 – OK’	Data is present and the response is returned.
Response:
<alertWebServiceResponse>
<messages>
<message>1 alert(s) returned</message>	Status Message. Alert count is shown if the method execution is successful. A descriptive error message is shown if the method execution failed.
</messages>
<alerts>
<alert>
<id>5</id>
<deviceUuid>6482dce2-ea75-400a-9f2c-d67766d942cf</deviceUuid>
<dispatchDeviceUuid>6482dce2-ea75-400a-9f2c-d67766d942cf</dispatchDeviceUuid>
<userUuid>asdasd-34sd-234sdf-sfsdfd</userUuid>	uuid of the user.
<labelId>1</labelId>	The internal id of the label that triggered the alert.
<eventSubscriptionName>m1</eventSubscriptionName>
<alertDate>2010-05-01T01:02:00+00:00</alertDate>
<alertText>WARNING::Memory size exceeded 1% for Phone #: 14085551212 (miadmin), Total Memory Size: 154.86MB, Free Memory Size: 133.59MB</alertText>	Alert content.
<isActive>false</isActive>	true -- the alert is unread. false -- the alert is read.
<retries>0</retries>	The number of attempts that have been made to send this alert.
<updateBy>alertprocessor</updateBy>
<updatedAt>2010-04-30T01:04:00+00:00</updatedAt>
<userName>miadmin</userName>	Recipient user name.
<alertDefnname>MEMORY_SIZE_EXCEEDED_ALERT</alertDefnname>	Alert type.
<severity>WARNING</severity>	Alert severity: INFORMATION WARNING CRITICAL
<transport>EMAIL</transport>	Means by which alert is communicated: EMAIL SMS APNS (iPhone only)
<status>DISPATCHED</status>	Alert dispatch status (as described in the Alerts section above): CREATED PROCESSED DISPATCH_PENDING DISPATCHING DISPATCHED DISPATCH_FAILED
<isAlertRead>true</isAlertRead>	Not used. The isActive field indicates whether the alert is read or unread.
</alert>
</alerts>
</alertWebServiceResponse>

Get all Alerts for User

This API returns all alerts for a single user. Because users may have multiple devices, this API returns all alerts on all devices matching the username. You can further filter the alerts by their read/unread status.

The fields in the response are the same as the fields in the Get All Alerts Response. However, the set of alerts is limited to alerts for the user specified in the request.

Examples:

Get all alerts for a user:

https://<Ivanti EPMM>/api/v1/alerts/users/jdoe

Get all unread alerts for a user:

https://<Ivanti EPMM>/api/v1/alerts/users/jdoe?isRead=false

URI: https:///api/v1/alerts/users/	Returns list of all alerts for the input user name.
Http Method:	GET
Format:	xml, json
Request:
Username	Required. Unique login user name.
isRead	Filter by the read status of the alert. True returns all alerts which are marked read. False returns all the alerts which are marked unread.

Response Status Code:
‘404 – No Data Found’	There is no data.
‘200 – OK’	Data is present and the response is returned.
Response:
<alertWebServiceResponse>
<messages>
<message>1 alert(s) returned</message>	Status Message. Alert count is shown if the method execution is successful. A descriptive error message is shown if the method execution failed.
</messages>
<alerts>
<alert>
<id>5</id>
<deviceUuid>6482dce2-ea75-400a-9f2c-d67766d942cf</deviceUuid>
<dispatchDeviceUuid>6482dce2-ea75-400a-9f2c-d67766d942cf</dispatchDeviceUuid>
<userUuid>asdasd-34sd-234sdf-sfsdfd</userUuid>	uuid of the user.
<labelId>1</labelId>	The internal id of the label that triggered the alert.
<eventSubscriptionName>m1</eventSubscriptionName>
<alertDate>2010-05-01T01:02:00+00:00</alertDate>
<alertText>WARNING::Memory size exceeded 1% for Phone #: 14085551212 (miadmin), Total Memory Size: 154.86MB, Free Memory Size: 133.59MB</alertText>	Alert content.
<isActive>false</isActive>	true -- the alert is unread. false -- the alert is read.
<retries>2</retries>	Number of attempts that have been made to send this alert.
<updateBy>alertprocessor</updateBy>
<updatedAt>2010-04-30T01:04:00+00:00</updatedAt>
<userName>miadmin</userName>	Recipient user name.
<alertDefnname>MEMORY_SIZE_EXCEEDED_ALERT</alertDefnname>	Alert type.
<severity>WARNING</severity>	Alert severity: INFORMATION WARNING CRITICAL
<transport>EMAIL</transport>	Means by which alert is communicated: EMAIL SMS APNS (iPhone only)
<status>DISPATCHED</status>	Alert dispatch status: CREATED PROCESSED DISPATCH_PENDING DISPATCHING DISPATCHED DISPATCH_FAILED
<isAlertRead>true</isAlertRead>	Not used. The isActive field indicates whether the alert is read or unread.
</alert>
</alerts>
</alertWebServiceResponse>

Get All Alerts for a Phone Number of a User

This API returns all alerts for a single phone number of a user. You can further filter the alerts by their read/unread status.

The fields in the response are the same as the fields in the Get All Alerts Response. However, the set of alerts is limited to alerts for the user specified in the request.

Example:

https://<Ivanti EPMM>/api/v1/alerts/users/jdoe/phones/16505551212

URI: https:///api/v1/alerts/users//phones/	Returns list of all alerts for the input phone number of the input user name.
Http Method:	GET
Format:	xml, json
Request:
Username	Required. Unique login user name.
phoneNumber	Required. Phone number.
isRead	Filter by the read status of the alert. True returns all alerts which are marked read. False returns all the alerts which are marked unread.

Response Status Code:
‘404 – No Data Found’	There is no data.
‘200 – OK’	Data is present and the response is returned.
Response:
<alertWebServiceResponse>
<messages>
<message>1 alert(s) returned</message>	Status Message. Alert count is shown if the method execution is successful. A descriptive error message is shown if the method execution failed.
</messages>
<alerts>
<alert>
<id>5</id>
<deviceUuid>6482dce2-ea75-400a-9f2c-d67766d942cf</deviceUuid>
<dispatchDeviceUuid>6482dce2-ea75-400a-9f2c-d67766d942cf</dispatchDeviceUuid>
<userUuid>asdasd-34sd-234sdf-sfsdfd</userUuid>	uuid of the user.
<labelId>1</labelId>	The internal id of the label that triggered the alert.
<eventSubscriptionName>m1</eventSubscriptionName>
<alertDate>2010-05-01T01:02:00+00:00</alertDate>
<alertText>WARNING::Memory size exceeded 1% for Phone #: 14085551212 (miadmin), Total Memory Size: 154.86MB, Free Memory Size: 133.59MB</alertText>	Alert content.
<isActive>false</isActive>	true -- the alert is unread. false -- the alert is read.
<retries>2</retries>	Number of attempts that have been made to send this alert.
<updateBy>alertprocessor</updateBy>
<updatedAt>2010-04-30T01:04:00+00:00</updatedAt>
<userName>miadmin</userName>	Recipient user name.
<alertDefnname>MEMORY_SIZE_EXCEEDED_ALERT</alertDefnname>	Alert type.
<severity>WARNING</severity>	Alert severity: INFORMATION WARNING CRITICAL
<transport>EMAIL</transport>	Means by which alert is communicated: EMAIL SMS APNS (iPhone only)
<status>DISPATCHED</status>	Alert dispatch status: CREATED PROCESSED DISPATCH_PENDING DISPATCHING DISPATCHED DISPATCH_FAILED
<isAlertRead>true</isAlertRead>	Not used. The isActive field indicates whether the alert is read or unread.
</alert>
</alerts>
</alertWebServiceResponse>

Update Alert

This API updates the read/unread status and comments to a particular alert.

Example:

https://<Ivanti EPMM>/api/v1/alerts/ 3936?isRead=false&comments=Reset

URI: https:///api/v1/alerts/	Updates the alert designated by the alert ID.
Http Method:	PUT
Format:	xml, json
Request:
Id	Required. Alert ID to be updated.
isRead	Required. True updates the alert as read. False updates the alert as unread.
Comments	Required. Comments to be added to the alert. Free form text field (255 character limit).

Response Status Code:
‘404 – No Data Found’	There is no data.
‘200 – OK’	Data is present and the response is returned.
Response:
<alertWebServiceResponse>
<messages>
<message>Updated alert 3936 successfully</message>	Status Message. Success is shown if the method execution is successful. A descriptive error message is shown if the method execution failed.
</messages>
</alertWebServiceResponse>

Update List of Alerts

This API updates the read/unread status and comments to multiple alerts, designated by a list of IDs.

Example:

https://<Ivanti EPMM>/api/v1/alerts?id=3936&id=3934&isRead=true&comments=”Jdoe read this alert”

URI: https:///api/v1/alerts/	Updates multiple alerts, designated by alert IDs.
Http Method:	PUT
Format:	xml, json
Request:
id	Required. Alert IDs to be updated. Note: The IDs are query parameters. For example: https:///api/v1/alerts?id=1&id=2&id3 Three alerts with ids= 1, 2 and 3 are updated with the specified isRead value and comments value.
isRead	Required. True updates the alert as read. False updates the alert as unread.
Comments	Required. Comments to be added to the alert. Free form text field (255 character limit).

Response Status Code:
‘404 – No Data Found’	There is no data.
‘200 – OK’	Data is present and the response is returned.
Response:
<alertWebServiceResponse>
<messages>
<message> Updated 10 alert(s) successfully</message>	Status Message. Alert update count is shown if the method execution is successful. A descriptive error message is shown if the method execution failed.
</messages>
</alertWebServiceResponse>