Skip to content

Update-IvantiBusinessObjectRelationship

SYNOPSIS

Update a relationship between business objects in Ivanti ITSM.

SYNTAX

businessObject

Update-IvantiBusinessObjectRelationship -businessObject <String> -recID <String>
 -relationBusinessObject <String> -relationBusinessObjectRecID <String> [-postBody <String>]
 [<CommonParameters>]

otherBusinessObject

Update-IvantiBusinessObjectRelationship -otherBusinessObject <String> -recID <String>
 -relationBusinessObject <String> -relationBusinessObjectRecID <String> [-postBody <String>]
 [<CommonParameters>]

DESCRIPTION

The `Update-BusinessObjectRelationship` function allows you to update a relationship between business objects in Ivanti ITSM. You can specify the business objects and their record IDs to establish or update the relationship. The function also accepts an optional post body for the request.

EXAMPLES

EXAMPLE 1

Update-BusinessObjectRelationship -businessObject 'incidents' -recID '12345' -relationBusinessObject 'cis' -relationBusinessObjectRecID '67890'

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

EXAMPLE 2

Update-BusinessObjectRelationship -otherBusinessObject 'customObject' -recID 'abc123' -relationBusinessObject 'customRelation' -relationBusinessObjectRecID 'def456' -postBody '{"key":"value"}'

Updates the relationship between the custom object with record ID 'abc123' and the custom relation with record ID 'def456', including a post body.

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: linkedBusinessObject, linkedBO, linkedBusinessObjectType, relationBusinessObjectType

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

-relationBusinessObjectRecID

The record ID of the related business object. This parameter is mandatory.

Type: String
Parameter Sets: (All)
Aliases: linkedBusinessObjectRecID, linkedBORecID, linkedBusinessObjectTypeRecID, relationBusinessObjectTypeRecID, linkedRecID

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 updating relationships between business objects in Ivanti ITSM.

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