Skip to content

Get-IvantiBusinessObjectRelationship

SYNOPSIS

Retrieve a relationship between business objects in Ivanti ITSM.

SYNTAX

businessObject

Get-IvantiBusinessObjectRelationship -businessObject <String> -recID <String> -relationBusinessObject <String>
 [<CommonParameters>]

otherBusinessObject

Get-IvantiBusinessObjectRelationship -otherBusinessObject <String> -recID <String>
 -relationBusinessObject <String> [<CommonParameters>]

DESCRIPTION

The `Get-BusinessObjectRelationship` function allows you to retrieve a relationship between business objects in Ivanti ITSM. You can specify the business objects and their record IDs to get the relationship details.

EXAMPLES

EXAMPLE 1

Get-BusinessObjectRelationship -businessObject 'incidents' -recID '12345' -relationBusinessObject 'cis'

Retrieves the relationship between the incident with record ID '12345' and the CI.

EXAMPLE 2

Get-BusinessObjectRelationship -otherBusinessObject 'customObject' -recID 'abc123' -relationBusinessObject 'customRelation'

Retrieves the relationship between the custom object with record ID 'abc123' and the custom relation.

PARAMETERS

-businessObject

The type of the primary business object. 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 primary 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

-relationBusinessObject

The type of the related business object. This parameter is mandatory.

Type: String
Parameter Sets: (All)
Aliases: relationObject, relationBO, relationship

Required: True
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 retrieving relationships between business objects in Ivanti ITSM.

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