internal/functions/Edit-SMAXAssociation.ps1
|
function Edit-SMAXAssociation { <# .SYNOPSIS Edits associations between entities in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Edit-SMAXAssociation function allows you to create or delete associations between entities in SMAX. You can specify the entity names, IDs, association type, operation (Create or Delete), and bulk operation parameters. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER EntityType Specifies the name of the source entity from which the association is created. .PARAMETER EntityId Specifies the ID of the source entity from which the association is created. .PARAMETER RemoteId Specifies the ID of the remote entity to associate with. .PARAMETER Association Specifies the type of association between the entities. .PARAMETER Operation Specifies the operation to perform on the associations. It can be "Create" or "Delete." .PARAMETER BulkID Specifies the bulk operation ID when performing bulk association operations. .PARAMETER ExecuteBulk Indicates whether to execute a bulk association operation. .EXAMPLE Edit-SMAXAssociation -EntityType Request -EntityId 400551 -Association FollowedByUsers -remoteId 388154 -Operation Create Adds the person 388154 to the Request 400551 as a follower. .EXAMPLE Edit-SMAXAssociation -EntityType Request -EntityId 400551 -Association FollowedByUsers -remoteId 388154 -BulkID MyBulk Edit-SMAXAssociation -EntityType Request -EntityId 400551 -Association FollowedByUsers -remoteId 115 -BulkID MyBulk Edit-SMAXAssociation -BulkID MyBulk -Operation Create -ExecuteBatch Adds the persons 388154 and 115 to the Request 400551 as a follower in a single web request. .NOTES General notes #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [int]$EntityId, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [int]$RemoteId, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityAssociations")] [string]$Association, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [ValidateSet('Create', 'Delete')] [string]$Operation, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [string]$BulkID, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [switch]$ExecuteBulk ) if (-not $ExecuteBulk){ Write-PSFMessage "No Bulk Execution, creating new relationship object" $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).entityDefinition" if ([string]::IsNullOrEmpty($definitions)) { Stop-PSFFunction -EnableException $EnableException -Message "SMAX Entitymodel not initialized, please run Initialize-SMAXEntityModel" } $secondEndpoint = $definitions.$EntityType.associations | Where-Object name -eq $Association | Select-Object -ExpandProperty linkEntityName if ([string]::IsNullOrEmpty($secondEndpoint)) { Stop-PSFFunction -EnableException $EnableException -Message "Could not find secondEndpoint for '$EntityType' association '$Association'" } $newRel = [PSCustomObject]@{ name = $Association firstEndpoint = [PSCustomObject]@{ $EntityType = $EntityId } secondEndpoint = [PSCustomObject]@{ $secondEndpoint = $RemoteId } } } switch -regex ($PSCmdlet.ParameterSetName){ "singleAssociation"{ Write-PSFMessage "SingleRelation" $relationships=@($newRel) # $relationships = new System.Collections.ArrayList } 'Bulk'{ if([string]::IsNullOrEmpty($Script:EntAssBulks)){ Write-PSFMessage "Initialisiere `$Script:EntAssBulks" $Script:EntAssBulks=@{} } if ($Script:EntAssBulks.containskey($BulkID)){ Write-PSFMessage "Using existing Bulk Collection $BulkID" $relationships=$Script:EntAssBulks.$BulkID } else{ Write-PSFMessage "Starting Bulk Collection $BulkID" $relationships = new System.Collections.ArrayList $Script:EntAssBulks.$BulkID = $relationships } } 'BuildBulk'{ [void]$relationships.add($newRel) return } 'executeBulk'{ if ([string]::IsNullOrEmpty($relationships)){ # Write-PSFMessage -Level Warning Stop-PSFFunction -Message "No Bulk Data for '$BulkID' available" -EnableException $EnableException return } } } $apiCallParameter = @{ EnableException = $EnableException # EnablePaging = $EnablePaging Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Edit-SMAXAssociation" LoggingActionValues = @($Operation, $relationships.Count) method = "POST" Path = "/ems/bulk" body = @{ relationships = $relationships operation = $Operation.ToUpper() } } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json -Depth 5)" $result = Invoke-SMAXAPI @apiCallParameter #| Where-Object { $_.properties} Write-PSFMessage "`$result=$($result|ConvertTo-Json -Depth 5)" if($ExecuteBulk){ Write-PSFMessage "Bulk executed, clearing temp. cache" $Script:EntAssBulks.remove($BulkID) } return $result } |