Get Related Business Objects

Reference documentation for using the Ivanti Neurons for ITSM Get Related Business Objects action

Written By Support Channel

Last updated Over 1 year ago

Overview of the Get Related Business Objects action

The Get Related Business Objects action allows you to retrieve records that are linked to a business object from a specific relationship in Ivanti Neurons for ITSM using the Get Related Business Objects API.

Purpose	To fetch JSON records from a specified business object in a specific relationship within Ivanti Neurons for ITSM using search, filter, and sort options.
Parameters	1 Neurons for ITSM Instance 1 Business Object Name 1 Relationship 1 Parent Business Object Unique ID 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 Get Business Objects action

The Get Related Business Objects action is used to retrieve records that are related to a specific record in Ivanti Neurons for ITSM, such as Tasks related to Incidents. The action supports search terms, filters, sorting, and record limits to help you control exactly what data is returned.

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

Relationship

Specify the name of the relationship you want to retrieve the records from

Parent Business Object Unique ID

Provide the Unique Key of the parent record you want to pull related data from.

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 Get Related Business Objects action

The Get Related Business Objects action helps you find records that are connected to another record. For example, if you're working with a change request and want to get a list of its approvers, you can use this action by entering the record's RecId and the relationship of the business objects.

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 Get Related Business Objects actions

Add a Get Related Business Objects action

Add the action

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

How to add an action to a workflow

Click the ‘plus’ symbol on the workflow path at the point you want to insert the action. This opens the action menu slide-over.
Either:
- Search for the action using the Search field above the actions in the menu.
- Locate a Recently Used action in the top section of the menu.
- Navigate to the action within menu: Core actions are listed under Actions, while Plugin actions are contained within their associated integration.
Select the desired action to insert it. This reveals the action’s configuration panel.
Use the Name field to name the action. This can help users to understand your workflow at a glance. (optional)
Use the Description field to add information describing the action. This can help users wanting to understand how your workflow functions (optional).

Configure the action

Use the following steps to configure the action.

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

Delete a Get Related Business Objects action

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

How to remove an action from a workflow

Access the workflow in draft mode to edit it.
Either:
- hover your mouse cursor over the action, and then click the red cross that appears over the top-right corner of the action to delete it. Or:
- click on the action to open the action slide-over. Click the red 'Delete Step’ button to remove the action from your workflow.
Click Publish in the top-right to commit your changes.

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.

Was this helpful?

Still need help? Share an idea