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

    Get All Incident Filters

    Use this API to retrieve information about all incident filters configured in Junos Space Service Now.

    URI

    https://[host]/api/juniper/servicenow/incident-filter-management/incidentFilters (HTTP method = GET)

    URI Parameters

    None

    Consumes

    None

    Produces

    • application/vnd.juniper.servicenow.incident-filter-management.filters+xml;version=1
    • application/vnd.juniper.servicenow.incident-filter-management.filters+json;version=1

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI to the collection of incident filters

    size

    Integer

    Number of incident filters in the collection of incident filters

    filter

    filter

    An incident filter

    href

    String

    Link to the incident filter

    uri

    String

    URI of the incident filter

    id

    Integer

    ID of the incident filter

    name

    String

    Name of the incident filter

    type

    String

    Type of Incident filter

    Possible values:

    • Basic
    • Advanced

    action

    String

    Action defined in the incident filter

    Possible values:

    • Create Incident
    • Do Not Create Incident

    createdBy

    String

    User who created the incident filter

    lastUpdated

    String

    Date and time (in the yyyy-dd-mm hh:mm:ss timezone format) when the incident filter was last updated

    created

    String

    Date and time (in the yyyy-dd-mm hh:mm:ss timezone format) when the incident filter was created

    priority

    String

    Order in which the incident filter is applied to JMBs

    status

    String

    Status of the incident filter.

    Possible values:

    • Enabled—The incident filter can be applied to JMBs
    • Disabled—The incident filter cannot be applied to JMBs

    method

    String

    Methods applicable to the incident filter

    Sample Output

    Sample XML Output

    <filters uri="/api/juniper/servicenow/incident-filter-management/incidentFilters" size="1">
    <filter href= "/api/juniper/servicenow/incident-filter-management/incidentFilters/689568" uri="/api/juniper/servicenow/incident-filter-management/incidentFilters/689568" key="689568">
    <id>689568</id>
    <name>test</name>
    <type>Basic</type>
    <action>Do Not Create Incident</action>
    <createdBy>super</createdBy>
    <lastUpdated>2017-06-07 05:05:26 UTC</lastUpdated>
    <created>2017-06-07 05:05:26 UTC</created>
    <priority>1</priority>
    <status>Enabled</status>
    </filter>
    <method href= "/api/juniper/servicenow/incident-filter-management/incidentFilters/delete" />
    <method href= "/api/juniper/servicenow/incident-filter-management/incidentFilters/enable" />
    <method href= "/api/juniper/servicenow/incident-filter-management/incidentFilters/disable" />
    <method href= "/api/juniper/servicenow/incident-filter-management/incidentFilters/export" />
    <method href= "/api/juniper/servicenow/incident-filter-management/incidentFilters/reorder" />
    </filters>
    

    Sample JSON Output

    {
      "filters": {
        "@uri": "/api/juniper/servicenow/incident-filter-management/incidentFilters",
        "@size": "1",
        "filter": {
          "@href": "/api/juniper/servicenow/incident-filter-management/incidentFilters/689568",
          "@uri": "/api/juniper/servicenow/incident-filter-management/incidentFilters/689568",
          "@key": "689568",
          "id": 689568,
          "name": "test",
          "type": "Basic",
          "action": "Do Not Create Incident",
          "createdBy": "super",
          "lastUpdated": "2017-06-07 05:05:26 UTC",
          "created": "2017-06-07 05:05:26 UTC",
          "priority": 1,
          "status": "Enabled"
        },
        "method": [
          {
            "@href": "/api/juniper/servicenow/incident-filter-management/incidentFilters/delete"
          },
          {
            "@href": "/api/juniper/servicenow/incident-filter-management/incidentFilters/enable"
          },
          {
            "@href": "/api/juniper/servicenow/incident-filter-management/incidentFilters/disable"
          },
          {
            "@href": "/api/juniper/servicenow/incident-filter-management/incidentFilters/export"
          },
          {
            "@href": "/api/juniper/servicenow/incident-filter-management/incidentFilters/reorder"
          }
        ]
      }
    }
    

    Modified: 2017-07-18