Get-IvantiBusinessObject

SYNOPSIS

Retrieves business objects from Ivanti ITSM.

SYNTAX

RecID (Default)

Get-IvantiBusinessObject -RecID <String> -businessObject <String> [-top <Int32>] [<CommonParameters>]

params

Get-IvantiBusinessObject -params <Hashtable> [-top <Int32>] [<CommonParameters>]

Search

Get-IvantiBusinessObject -search <String> -businessObject <String> [-top <Int32>] [<CommonParameters>]

filter

Get-IvantiBusinessObject -filter <String> -businessObject <String> [-top <Int32>] [<CommonParameters>]

DESCRIPTION

Retrieves business objects from Ivanti ITSM based on specified parameters such as record ID, search criteria, filter, or a set of parameters. Allows selecting specific fields and limiting the number of results.

EXAMPLES

EXAMPLE 1

Get-BusinessObject -businessObject 'incident' -RecID 'abc123'

Retrieves the incident with the record ID 'abc123'.

EXAMPLE 2

Get-BusinessObject -businessObject 'incident' -search 'Incident123'

Retrieves the incident with the search criteria 'Incident123'.

EXAMPLE 3

Get-BusinessObject -businessObject 'incident' -filter "Status eq 'Active'"

Retrieves active incidents with the specified filter.

EXAMPLE 4

Get-BusinessObject -params @{ 'businessObject' = 'incident'; 'RecID' = 'abc123' }

Retrieves the incident with the specified parameters.

PARAMETERS

-params

A hashtable of parameters to specify the business object to be retrieved.

Type: Hashtable
Parameter Sets: params
Aliases: Parameters

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RecID

The record ID of the business object to be retrieved.

Type: String
Parameter Sets: RecID
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-search

The search criteria to find the business object to be retrieved.

Type: String
Parameter Sets: Search
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-filter

The filter criteria to find the business object to be retrieved.

Type: String
Parameter Sets: filter
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-businessObject

The type of the business object to be retrieved.

Type: String
Parameter Sets: RecID, Search, filter
Aliases: businessObjectType, BO, ObjectType

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-top

The maximum number of results to return.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Get-Business-Objects.htm