functions/Stop-JS7DailyPlanOrder.ps1
|
function Stop-JS7DailyPlanOrder { <# .SYNOPSIS Cancels daily plan orders from a JS7 Controller .DESCRIPTION Cancels daily plan orders from a JS7 Controller. The following REST Web Service API resources are used: * /orders/daily_plan/cancel .PARAMETER OrderId Optionally specifies the Order ID of the daily plan order that should be cancelled. .PARAMETER ControllerId Specifies the Controller to which daily plan orders have been submitted and should be cancelled. Without this parameter daily plan orders are cancelled from any Controllers that are deployed together with the workflows that are indicated with their respective parameters. .PARAMETER DateFrom Optionally specifies the date starting from which daily plan orders should be cancelled. Consider that a UTC date has to be provided. Default: Beginning of the current day as a UTC date .PARAMETER DateTo Optionally specifies the date until which daily plan orders should be cancelled. Consider that a UTC date has to be provided. Default: End of the current day as a UTC date .PARAMETER RelativeDateFrom Specifies a relative date starting from which daily plan orders should be cancelled, e.g. * -1d, -2d: one day ago, two days ago * +1d, +2d: one day later, two days later * -1w, -2w: one week ago, two weeks ago * +1w, +2w: one week later, two weeks later * -1M, -2M: one month ago, two months ago * +1M, +2M: one month later, two months later * -1y, -2y: one year ago, two years ago * +1y, +2y: one year later, two years later Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed. This parameter takes precedence over the -DateFrom parameter. .PARAMETER RelativeDateTo Specifies a relative date until which daily plan orders should be cancelled, e.g. * -1d, -2d: one day ago, two days ago * +1d, +2d: one day later, two days later * -1w, -2w: one week ago, two weeks ago * +1w, +2w: one week later, two weeks later * -1M, -2M: one month ago, two months ago * +1M, +2M: one month later, two months later * -1y, -2y: one year ago, two years ago * +1y, +2y: one year later, two years later Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed. This parameter takes precedence over the -DateTo parameter. .PARAMETER AuditComment Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc. The Audit Comment is visible from the Audit Log view of the JOC Cockpit. This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions. .PARAMETER AuditTimeSpent Specifies the duration in minutes that the current intervention required. This information is shown in the Audit Log view. It can be useful when integrated with a ticket system that logs the time spent on interventions with JS7. .PARAMETER AuditTicketLink Specifies a URL to a ticket system that keeps track of any interventions performed for JS7. This information is shown in the Audit Log view of JOC Cockpit. It can be useful when integrated with a ticket system that logs interventions with JS7. .OUTPUTS This cmdlet returns no output. .EXAMPLE Stop-JS7DailyPlanOrder -DateFrom "2020-12-31" Cancels any daily plan orders for the given date. .EXAMPLE Stop-JS7DailyPlanOrder -DateTo (Get-Date).AddDays(3) Cancels any daily plan orders starting from today until a date three days from now. .EXAMPLE Stop-JS7DailyPlanOrder -OrderId "#2020-11-19#P0000000498-orderSampleWorfklow2a" Cancels the order with the given Order ID from the daily plan. .LINK about_JS7 #> [cmdletbinding(SupportsShouldProcess)] param ( [Parameter(Mandatory=$False,ValueFromPipelinebyPropertyName=$True)] [string] $OrderId, [Parameter(Mandatory=$False,ValueFromPipelinebyPropertyName=$True)] [string] $ControllerId, [Parameter(Mandatory=$False,ValueFromPipelinebyPropertyName=$True)] [DateTime] $DateFrom = (Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd'), [Parameter(Mandatory=$False,ValueFromPipelinebyPropertyName=$True)] [DateTime] $DateTo, [Parameter(Mandatory=$False,ValueFromPipelinebyPropertyName=$True)] [string] $RelativeDateFrom, [Parameter(Mandatory=$False,ValueFromPipelinebyPropertyName=$True)] [string] $RelativeDateTo, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [string] $AuditComment, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [int] $AuditTimeSpent, [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)] [Uri] $AuditTicketLink ) Begin { Approve-JS7Command $MyInvocation.MyCommand $stopWatch = Start-JS7StopWatch $orderIds = @() } Process { Write-Debug ".. $($MyInvocation.MyCommand.Name): parameter OrderId=$OrderId" if ( $OrderId ) { $orderIds += $OrderId } } End { if ( $RelativeDateFrom ) { $dateDirection = $RelativeDateFrom[0] $dateRange = $RelativeDateFrom.Substring( 1, $RelativeDateFrom.Length-2 ) $dateUnit = $RelativeDateFrom[$RelativeDateFrom.Length-1] switch( $dateUnit ) { 'd' { $dailyPlanDateFrom = (Get-Date).AddDays( "$($dateDirection)$($dateRange)" ) } 'w' { $dailyPlanDateFrom = (Get-Date).AddDays( "$($dateDirection)$([int]$dateRange*7)" ) } 'm' { $dailyPlanDateFrom = (Get-Date).AddMonths( "$($dateDirection)$($dateRange)" ) } 'y' { $dailyPlanDateFrom = (Get-Date).AddYears( "$($dateDirection)$($dateRange)" ) } } } else { $dailyPlanDateFrom = Get-Date (Get-Date $DateFrom) } if ( $RelativeDateTo ) { $dateDirection = $RelativeDateTo[0] $dateRange = $RelativeDateTo.Substring( 1, $RelativeDateTo.Length-2 ) $dateUnit = $RelativeDateTo[$RelativeDateTo.Length-1] switch( $dateUnit ) { 'd' { $dailyPlanDateTo = (Get-Date).AddDays( "$($dateDirection)$($dateRange)" ) } 'w' { $dailyPlanDateTo = (Get-Date).AddDays( "$($dateDirection)$([int]$dateRange*7)" ) } 'm' { $dailyPlanDateTo = (Get-Date).AddMonths( "$($dateDirection)$($dateRange)" ) } 'y' { $dailyPlanDateTo = (Get-Date).AddYears( "$($dateDirection)$($dateRange)" ) } } } else { if ( !$DateTo ) { $DateTo = $dailyPlanDateFrom } $dailyPlanDateTo = Get-Date (Get-Date $DateTo) } Write-Verbose ".. $($MyInvocation.MyCommand.Name): cancelling daily plan orders for date range $dailyPlanDateFrom - $dailyPlanDateTo" $loops = 0 for( $day=$dailyPlanDateFrom; $day -le $dailyPlanDateTo; $day=$day.AddDays(1) ) { $body = New-Object PSObject if ( $ControllerId ) { Add-Member -Membertype NoteProperty -Name 'controllerId' -value $ControllerId -InputObject $body } else { Add-Member -Membertype NoteProperty -Name 'controllerId' -value $script:jsWebService.ControllerId -InputObject $body } if ( $orderIds ) { Add-Member -Membertype NoteProperty -Name 'orderIds' -value $orderIds -InputObject $body } Add-Member -Membertype NoteProperty -Name 'dailyPlanDateFrom' -value (Get-Date $day -Format 'yyyy-MM-dd') -InputObject $body if ( $AuditComment -or $AuditTimeSpent -or $AuditTicketLink ) { $objAuditLog = New-Object PSObject Add-Member -Membertype NoteProperty -Name 'comment' -value $AuditComment -InputObject $objAuditLog if ( $AuditTimeSpent ) { Add-Member -Membertype NoteProperty -Name 'timeSpent' -value $AuditTimeSpent -InputObject $objAuditLog } if ( $AuditTicketLink ) { Add-Member -Membertype NoteProperty -Name 'ticketLink' -value $AuditTicketLink -InputObject $objAuditLog } Add-Member -Membertype NoteProperty -Name 'auditLog' -value $objAuditLog -InputObject $body } if ( $PSCmdlet.ShouldProcess( $Path, '/daily_plan/orders/cancel' ) ) { [string] $requestBody = $body | ConvertTo-Json -Depth 100 $response = Invoke-JS7WebRequest -Path '/daily_plan/orders/cancel' -Body $requestBody if ( $response.StatusCode -eq 200 ) { $requestResult = ( $response.Content | ConvertFrom-Json ) if ( !$requestResult.ok ) { throw ( $response | Format-List -Force | Out-String ) } } else { throw ( $response | Format-List -Force | Out-String ) } Write-Verbose ".. $($MyInvocation.MyCommand.Name): Daily Plan orders cancelled for: $(Get-Date $day -Format 'yyyy-MM-dd')" } $loops++ } if ( $loops ) { Write-Verbose ".. $($MyInvocation.MyCommand.Name): Daily Plan orders cancelled for $loops days" } else { Write-Verbose ".. $($MyInvocation.MyCommand.Name): no Daily Plan orders cancelled" } Trace-JS7StopWatch -CommandName $MyInvocation.MyCommand.Name -StopWatch $stopWatch Update-JS7Session } } |