Skip to main content
Neurons for ITSM Actions

Get Business Object By Unique Key

Reference documentation for using the Ivanti Neurons for ITSM Get Business Object By Unique Key action

Written By Support Channel

Last updated Over 1 year ago

Overview of the Get Business Object By Unique Key action

The Get Business Object by Unique Key action allows you to retrieve a specific record from a business object in Ivanti Neurons for ITSM using its Unique Key (RecId) with the Get a Business Object by ReclD or Unique Key API.

Purpose

Retrieve a single business object record using its RecId

Parameters

1 Neurons for ISM Instance
1 Business Object
1 Unique Key

Output

Business Object Record

Understanding the Get Business Object By Unique Key action

The Get Business Object by Unique Key action is used to look up and output a specific record from a business object by referencing its RecId (the unique identifier automatically assigned to each record in Ivanti Neurons for ITSM).

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

Unique Key

The unique identifier of the record the action will run against. (RecId)

Create and manage Get Business Object By Unique Key actions

Add a Get Business Object By Unique Key action

Add the action

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

  1. Click the ‘plus’ symbol on the workflow path at the point you want to insert the action. This opens the action menu slide-over.

  2. 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.

  3. Select the desired action to insert it. This reveals the action’s configuration panel.

  4. Use the Name field to name the action. This can help users to understand your workflow at a glance. (optional)

  5. 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.

  1. Set values for the Neurons for ITSM System, Business Object and Unique Key.

  2. Click back in the main view to hide the slide-over.

Delete a Get Business Object By Unique Key action

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

  1. Access the workflow in draft mode to edit it.

  2. 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.

  3. 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