Change Status of a Service Now Notification
Use this API to enable or disable a Service Now notification.
A notification in the form of e-mail or SNMP trap is sent to users only if the notification is enabled when a trigger occurs in Service Now.
URI
https://[host]/api/juniper/servicenow/notification-management/notifications/{id} /changeStatus (HTTP method = PUT)
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | Integer | Yes | ID of the notification to be enabled or disabled |
Consumes
None
Produces
- application/vnd.juniper.servicenow.notification-management.notification+xml;version=1
- application/vnd.juniper.servicenow.notification-management.notification+json;version=1
Response Elements
Element | Type | Description |
---|---|---|
uri | String | URI of the Service Now notification to be enabled or disabled |
id | Integer | ID of the notification |
actions | actions | Collection of actions taken for the notification |
emails | Collection of e-mails to be notified | |
String | E-mail ID to which notification is to be sent | |
snmpTraps | snmpTraps | Collection of SNMP traps to which the notification must be sent |
snmpTrap | snmpTrap | An SNMP trap |
uri | String | URI of the SNMP trap |
href | String | Link to the SNMP trap |
filtersApplied | filtersApplied | Filters applied for the notification |
organization | String | Organization used in the filter |
deviceGroup | String | Device group used in the filter |
deviceName | String | Device name used in the filter |
deviceState | String | Device state used in the filter |
serialNumber | String | Device serial number used in the filter |
hasTheWords | Integer | String used in the filter An object is filtered and a notification sent when the object contains the words in this element |
doesnotHaveTheWords | Integer | Strings used in the filter An object is filtered when the object does not contain the words in this element |
jmbAttachment | String | Name of the JMB attachment file used in the filter |
priority | String | Priority of the incident used in the filter Possible values—None, Critical, High, Medium, and Low |
intelligenceUpdateType | String | Intelligence update type used in the filter |
productsAffected | String | Products used to filter a received intelligence update |
platformType | String | Types of platforms used to filter a received intelligence update |
keywords | String | Keywords used to filter a received intelligence update |
softwareVersion | String | Junos OS software version used to filter a received intelligence update |
hardwareVersion | String | Product hardware version used to filter a received intelligence update |
devicesImpacted | String | Devices impacted used to filter a received intelligence update |
connectedMemberName | String | Name of end customer used in the filter |
biosStatus | String | BIOS status used to filter BIOS information updates Possible values:
|
name | String | Name of the notification |
owner | String | User to whom the notification is assigned for ownership |
status | String | Status of the notification policy Possible Values
|
trigger | String | Trigger to send e-mail or SNMP traps to users when conditions specified in the filter are met Possible values:
|
domain | String | Domain to which the notification is assigned |
method | String | Methods used by the notification |
Sample Output
Sample XML Output
<notification uri="/api/juniper/servicenow/notification-management/notifications/65555 /changeStatus"> <id>65555</id> <actions> <emails> <email>pbiswas@juniper.net</email> </emails> </actions> <filtersApplied> <deviceName>None</deviceName> <deviceState>None</deviceState> </filtersApplied> <name>EC</name> <owner>super</owner> <status>Disabled</status> <trigger>Connected Member Device Added/Removed</trigger> <domain>Global</domain> <method href= "/api/juniper/servicenow/notification-management/notifications/65555/changeStatus" /> <method href= "/api/juniper/servicenow/notification-management/notifications/65555/copy" /> <method href= "/api/juniper/servicenow/notification-management/notifications/65555/editFilterAndAction" /> <method href= "/api/juniper/servicenow/notification-management/notifications/65555" /> </notification>
Sample JSON Output
{ "notification": { "@uri": "/api/juniper/servicenow/notification-management/notifications/65555/changeStatus", "id": "65555", "actions": { "emails": { "email": "pbiswas@juniper.net" } }, "filtersApplied": { "deviceName": "None", "deviceState": "None" }, "name": "EC", "owner": "super", "status": "Disabled", "trigger": "Connected Member Device Added/Removed", "domain": "Global", "method": [ { "@href": "/api/juniper/servicenow/notification-management/notifications/65555/changeStatus" }, { "@href": "/api/juniper/servicenow/notification-management/notifications/65555/copy" }, { "@href": "/api/juniper/servicenow/notification-management/notifications/65555/editFilterAndAction" }, { "@href": "/api/juniper/servicenow/notification-management/notifications/65555" } ] } } }