Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Delete Suppressed Events

    Use this API to delete Juniper Message Bundles (JMBs) for which incidents are not created in Junos Space Service Now.

    You can use this API to delete all JMBs, a specific JMB, or a few selected JMBs for which incidents are not created.

    Note: You can delete a single event by first retrieving the event and then using the delete API to delete the event information.

    URI

    https://[host]/api/juniper/servicenow/suppressed-event-management /suppressedEvents/delete (HTTP method = POST)

    URI Parameters

    None

    Consumes

    • application/vnd.juniper.servicenow.suppressed-event-management.suppressedEvents+ xml;version=1;charset=UTF-8
    • application/vnd.juniper.servicenow.suppressed-event-management.suppressedEvents+ json;version=1;charset=UTF-8

    Request Elements

    Element

    Type

    Description

    applyToAllSuppressedEvents>

    String

    Indicates if all JMBs related to suppressed events should be deleted

    Possible values

    • true—All JMBs related to suppressed events should be deleted
    • false—Indicated JMBs related to suppressed events should be deleted

      When value is set to false for this element, ID of JMBs of the suppressed events that you want to delete must be provided.

    id

    String

    ID of a JMB for which incident was not created

    Produces

    • application/vnd.juniper.servicenow.suppressed-event-management.servicenowmsg +xml;version=1
    • application/vnd.juniper.servicenow.suppressed-event-management.servicenowmsg +json;version=1

    Response Elements

    Element

    Type

    Description

    msg

    String

    Message indicating the result of deleting JMBs related to suppressed events

    Sample Input

    Sample XML Input

    <suppressedEvents>
    <applyToAllSuppressedEvents>false</applyToAllSuppressedEvents>
    <suppressedEvent>
    <id>7864342</id>
    </suppressedEvent>
    </suppressedEvents>
    

    Sample JSON Input

    {
       "suppressedEvents": {
          "applyToAllSuppressedEvents": "false",
          "suppressedEvent": {
             "id": "7864342"
          }
       }
    }
    

    Sample Output

    Sample XML Output

    <servicenowmsg>
    <msg>Suppressed Events deleted successfully.</msg>
    </servicenowmsg>
    

    Sample JSON Output

    {
       "servicenowmsg": {
          "msg": "Suppressed Events deleted successfully."
       }
    }
    

    Modified: 2017-07-18