Saved Search

Reference documentation for using the Ivanti Neurons for ITSM Saved Search action

Written By Support Channel

Last updated 8 months ago

Overview of the Saved Search action

The Saved Search action allows you to return records from a saved search configured in Ivanti Neurons for ITSM using the Saved Search API.

Purpose	To fetch records from a preconfigured saved search in Ivanti Neurons for ITSM
Parameters	1 Neurons for ISM Instance 1 Business Object Name 1 Search 1 Search Term (optional) 1 Filter Query (optional) 1 Sort By Field (optional) 1 First Record Index (optional) 1 Number of Records to Return (optional)
Output	JSON Array

Understanding the Saved Search action

The Saved Search action provides an easy way to reuse existing saved searches in your workflows. Saved searches are created within the Ivanti Neurons for ITSM environment and contain predefined filters and logic. Instead of recreating these filters in each workflow, you can reference the saved search directly.

Neurons for ISM System

Select the Ivanti Neurons for ITSM system that the schema will be retrieved from.

Business Object

Specify the exact name of the business object. For example: Incident

Search (Saved Search)

Name of Saved Search that will be used from your Ivanti environment.

Search (optional)
A keyword or phrase used to narrow results by matching against common fields like title or number.

Filter (optional)
A more specific way to control what is returned. Use OData style syntax, for example CountHelpful eq 50 or Status eq 'Active'.

Sort By (optional)
Choose a field to sort the returned records by. For example CreatedDateTime or Title.

First Record (optional)
Sets the starting point of the result set. For example if you want to skip the first few records and start at the 5th result, enter 5.

Number of Records (optional)
Limits how many records are returned. By default the query will return up to 25 records with a max of 100

Working with Saved Search action

This action supports additional configuration such as sorting, pagination, and limiting the number of results. The returned data can then be used across the rest of your workflow.

Once retrieved, related records can be looped through using a For Each action or passed into a card carousel, message, or any other action that supports this data.

Create and manage Saved Search actions

Add a Saved Search action

Add the action

Use the following steps to add the action to a workflow.

Configure the action

Use the following steps to configure the action.

Set values for the Neurons for ITSM System, Business Object, Search, Search, Filter, Sort By, First Record and Number of Records.
Click back in the main view to hide the slide-over.

Delete a Saved Search action

Use the following steps to remove the action from your workflow:

Take care when deleting an action to also remove any logic using its outputs: workflow steps may function incorrectly or break if they attempt to evaluate an output of a deleted action.