Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get Information About an Incident Filter

 

Use this API to retrieve information about an incident filter in Junos Space Service Now.

URI

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

URI Parameters

Element

Type

Required

Description

filterId

Integer

Yes

ID of the incident filter for which information is to be retrieved

Consumes

None

Produces

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

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

Response Elements

Element

Type

Description

uri

String

URI of the filter

id

Integer

ID of the filter

domanId

Integer

ID of the domain to which the filter is assigned

name

String

Name of the filter

type

String

Type of filter

Possible values:

  • Basic

  • Advanced

action

String

Action to be taken on JMBs that satisfy the filter terms and conditions

Possible values:

  • CreateIncident

  • DoNotCreateIncident

createdBy

String

User who created the filter

lastUpdated

String

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

Created

String

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

priority

Integer

Order in which the filter is applied to JMBs.

status

String

Status of the filter

Possible values:

  • Enabled—The filter can be applied to JMBs

  • Disabled—The filter cannot be applied to JMBs

advancedFilterAttribute

advancedFilterAttribute

Attributes and conditions defining the filter

Note: advancedFilterAttribute is applicable only for advanced incident filters

inputParams

String

JMB parameters used to define the filter terms

Note: inputParams is applicable only for advanced incident filters

perlFileContent

String

Perl script defining the filter logic

Note: perlFileContent is applicable only for advanced incident filters

perlFileName

String

Name of the Perl script file

Note: perlFileName is applicable only for advanced incident filters

termCriteria

String

Criterion for implementing the action defined in the filter

Possible values:

  • AND—The action defined in the filter is applied to a JMB only when the JMB matches all the terms defined in the filter

  • OR—The action defined in the filter is applied to a JMB when the JMB matches any term defined in the filter

filterAttribute

String

List of JMB attributes used in the filter

filterAttributes

filterAttribute

JMB attributes for filtering

name

String

Name of the filter attribute

Possible values—EventType, EventSynopsis, Description, DeviceName, Platform, Entity, EventOccuredDate, and DeviceIP

condition

String

Condition of the filter term

A filter attribute condition defines the conditions such as words that can be present or not present in an event synopsis, the date before or after which the event should occur, or specific platforms.

Possible values—Include, DoesNotInclude, Is, IsNot, Before, After, On, StartsWith, EndsWith, LessThan, GreaterThan

Note:

  • When the name element is set to EventOccuredDate, the possible values for the condition element are Before, After, and On.

  • When the name element is set to DeviceIP, the possible values for the condition element are Is, IsNot, LessThan, and GreaterThan

value

String

Reference value of the attribute to be considered for filtering a JMB

method

String

Methods applicable to the filter

Sample Output When a Basic Incident Filter is Retrieved

Sample XML Output

Sample JSON Output

Sample Output When an Advanced Incident Filter is Retrieved

Sample XML Output

Sample JSON Output

Related Documentation