Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get Information About an Auto Submit Filter

 

Use this API to retrieve information about a specific auto submit filter in Junos Space Service Now.

URI

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

URI Parameters

Element

Type

Required

Description

filterId

Integer

Yes

ID of the auto submit filter for which information is to be retrieved

Consumes

None

Produces

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

  • application/vnd.juniper.servicenow.autosubmit-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

Possible values:

  • SubmitCase

  • DoNotSubmitCase

  • AssociateToAnExistingCase

createdBy

String

User who created the filter

lastUpdated

String

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

Created

String

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

priority

Integer

Order in which the auto submit filter is applied to incidents

status

String

Status of the filter

Possible values:

  • Enabled—The filter can be applied to incidents

  • Disabled—The filter cannot be applied to incidents

advancedFilterAttribute

advancedFilterAttribute

Attributes and conditions defining the filter

Note: advancedFilterAttribute is applicable only for advanced auto submit filters

inputParams

String

Attributes of an Incident used to define the filter terms

Note: inputParams is applicable only for advanced auto submit filters

perlFileContent

String

Perl script defining the filter logic

Note: perlFileContent is applicable only for advanced auto submit filters

perlFileName

String

Name of the Perl script file

Note: perlFileName is applicable only for advanced auto submit filters

termCriteria

String

Criterion for implementing the action defined in the filter

Possible values:

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

  • OR—Action defined in the filter is applied to an incident when the incident matches any term defined in the filter

filterAttribute

String

List of incident attributes used in the filter

filterAttributes

filterAttribute

Incident attributes used for filtering

name

String

Name of the filter attribute

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

method

String

Methods applicable to the filter

Sample Output When a Basic Auto Submit Filter is Retrieved

Sample XML Output

Sample JSON Output

Sample Output When an Advanced Auto Submit Filter is Retrieved

Sample XML Output

Sample JSON Output