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

    Change Status of a Service Insight Notification

    Use this API to enable or disable a Junos Space Service Insight notification.

    URI

    https://[host]/api/juniper/serviceinsight/notification-management/notifications/{id}/ changeStatus (HTTP method = PUT)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the Service Insight notification to be enabled or disabled

    Consumes

    None

    Produces

    • application/vnd.juniper.serviceinsight.notification-management.notification+xml; version=1
    • application/vnd.juniper.serviceinsight.notification-management.notification+json; version=1

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI of the Service Insight notification to be enabled or disabled

    id

    Integer

    ID of the Service Insight notification

    actions

    actions

    Action defined for the notification

    emails

    email

    Collection of e-mail IDs to whom the notification must be flagged

    email

    String

    E-mail ID of users to which notifications must be flagged

    snmpTraps

    snmpTrap

    Collection of SNMP traps for sending notifications

    snmpTrap

    snmpTrap

    An SNMP trap

    uri

    String

    URI of the SNMP trap

    href

    String

    Link to the SNMP trap

    filter

    filter

    Filter used by Service Insight to send the notification as an e-mail or SNMP trap

    organization

    String

    Organization used in the filter

    deviceGroup

    String

    Device group used in the filter

    deviceName

    String

    Device name used in the filter

    serialNumber

    String

    Serial number of the device used in the filter

    hasTheWords

    String

    String used in the filter

    An object is filtered and a notification sent when the object contains the words in this element

    doesnotHaveTheWords

    String

    String used in the filter

    An object is filtered when the object does not contain the words in this element

    deviceGroupId

    Integer

    ID of the device group used in the filter

    organizationId

    Integer

    ID of the organization used in the filter

    id

    Integer

    ID of the notification

    name

    String

    Name of the notification

    owner

    String

    User who created the notification

    status

    String

    Status of the notification

    Possible Values

    • Enabled—An e-mail or SNMP trap is sent to users if the trigger occurs in Service Insight
    • Disabled—An e-mail or SNMP trap is not sent to users if the trigger occurs in Service Insight

    trigger

    String

    Trigger to send notification in the form of e-mail or SNMP traps to users when conditions specified in the trigger filter are met

    Possible values:

    • New EOL Match—A notification is sent when an EOL announcement is received and one or more devices are affected by the announcement
    • New PBN Arrival—A notification is sent when a new PBN is received and matches one or more devices.
    • New PBN Match—A notification is sent when a PBN affects one or more devices.

    domain

    String

    Domain to which the notification is assigned

    Sample Output

    Sample XML Output

    <notification uri="/api/juniper/serviceinsight/notification-management/notifications/753665/changeStatus">
    <id>753665</id>
    <actions>
    <emails>
    <email>bhuwan4@jbs.net</email>
    </emails>
    </actions>
    <filtersApplied>
    <organization>Juniper-ORG</organization>
    <deviceGroup>Default for Juniper-ORG</deviceGroup>
    <deviceName>TestDevice</deviceName>
    <serialNumber>TestNumber</serialNumber>
    <deviceGroupId>0</deviceGroupId>
    <organizationId>0</organizationId>
    </filtersApplied>
    <name>TestNotification4</name>
    <owner>super</owner>
    <status>Disabled</status>
    <trigger>New EOL Match</trigger>
    <domain>Global</domain>
    <method href= "/api/juniper/serviceinsight/notification-management/notifications/753665/changeStatus" />
    <method href= "/api/juniper/serviceinsight/notification-management/notifications/753665/copy" />
    <method href= "/api/juniper/serviceinsight/notification-management/notifications/753665 /editFiltersAndAction" />
    <collection href= "/api/juniper/serviceinsight/notification-management/notifications/753665" />
    </notification>
    

    Sample JSON Output

    {
      "notification": {
        "@uri": "/api/juniper/serviceinsight/notification-management/notifications/753665/changeStatus",
        "id": "753665",
        "actions": {
          "emails": { "email": "bhuwan4@jbs.net" }
        },
        "filtersApplied": {
          "organization": "Juniper-ORG",
          "deviceGroup": "Default for Juniper-ORG",
          "deviceName": "TestDevice",
          "serialNumber": "TestNumber",
          "deviceGroupId": "0",
          "organizationId": "0"
        },
        "name": "TestNotification4",
        "owner": "super",
        "status": "Disabled",
        "trigger": "New EOL Match",
        "domain": "Global",
        "method": [
          { "@href": "/api/juniper/serviceinsight/notification-management/notifications/753665/changeStatus" },
          { "@href": "/api/juniper/serviceinsight/notification-management/notifications/753665/copy" },
          { "@href": "/api/juniper/serviceinsight/notification-management/notifications/753665/editFiltersAndAction" }
        ],
        "collection": { "@href": "/api/juniper/serviceinsight/notification-management/notifications/753665" }
      }
    }
    

    Modified: 2016-08-10