Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Create a Basic Incident Filter

 

Use this API to create a basic incident filter in Junos Space Service Now.

URI

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

URI Parameters

None

Consumes

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

  • aapplication/vnd.juniper.servicenow.incident-filter-management.filter +json;version=1;charset=UTF-8

Request Elements

Element

Type

Description

name

String

Name of the basic incident filter

action

String

Action to be taken on the Juniper Message Bundle (JMB).

Possible values:

  • CreateIncident

  • DoNotCreateIncident

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

filterAttributes

filterAttribute

Attributes defined for filtering a JMB

name

String

Name of the JMB 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, and 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

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 value—Basic:

action

String

Action defined for the filter

createdBy

String

User who created the filter

priority

Integer

Priority of the filter

status

String

Status of the filter

Possible values

  • Enabled—The filter can be applied for filtering JMBs

  • Disabled-The filter cannot be applied for filtering JMBs

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 defined 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, and 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 considered for filtering a JMB

method

String

Methods applicable to the filter

Sample Input

Sample XML Input

Sample JSON Input

Sample Output

Sample XML Output

Sample JSON Output