Invoke-IvantiBusinessObjectQuickAction

SYNOPSIS

Invoke a quick action on a specified business object.

SYNTAX

RecID (Default)

Invoke-IvantiBusinessObjectQuickAction -recID <String> -quickAction <String> [-postBody <String>]
 [<CommonParameters>]

businessObject

Invoke-IvantiBusinessObjectQuickAction -businessObject <String> -recID <String> -quickAction <String>
 [-postBody <String>] [<CommonParameters>]

otherBusinessObject

Invoke-IvantiBusinessObjectQuickAction -otherBusinessObject <String> -recID <String> -quickAction <String>
 [-postBody <String>] [<CommonParameters>]

DESCRIPTION

The `Invoke-BusinessObjectQuickAction` function allows you to invoke a quick action on a specified business object in Ivanti ITSM. You can specify the business object type, record ID, and the quick action to be performed. Optionally, you can provide a post body for the request.

EXAMPLES

EXAMPLE 1

Invoke-BusinessObjectQuickAction -businessObject 'incidents' -recID '12345' -quickAction 'ResolveIncident'

Invokes the 'ResolveIncident' quick action on the incident with record ID '12345'.

EXAMPLE 2

Invoke-BusinessObjectQuickAction -otherBusinessObject 'customObject' -recID '67890' -quickAction 'CustomAction' -postBody '{"key":"value"}'

Invokes the 'CustomAction' quick action on the custom object with record ID '67890' and includes a post body.

PARAMETERS

-businessObject

The type of the business object on which the quick action will be invoked. This parameter is mandatory and accepts a predefined set of values.

Type: String
Parameter Sets: businessObject
Aliases: businessObjectType, BO, ObjectType

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

-otherBusinessObject

An alternative business object type. This parameter is mandatory when using the 'otherBusinessObject' parameter set.

Type: String
Parameter Sets: otherBusinessObject
Aliases: otherBusinessObjectType, otherBO

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

-recID

The record ID of the business object on which the quick action will be invoked. This parameter is mandatory.

Type: String
Parameter Sets: (All)
Aliases:

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

-quickAction

The quick action to be invoked on the business object. This parameter is mandatory.

Type: String
Parameter Sets: (All)
Aliases:

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

-postBody

An optional post body to be included in the request.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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

This function is useful for automating quick actions on business objects in Ivanti ITSM.

https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Quick-Actions-API.htm