Name
Remove-JS7DailyPlanOrder
SYNOPSIS
Removes the daily plan orders for a JS7 Controller
SYNTAX
Remove-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-SchedulePath] <String>] [[-DailyPlanDate] <DateTime>] [<CommonParameters>]
DESCRIPTION
Removes daily plan orders from a JS7 Controller.
PARAMETERS
OrderId
-OrderId <String>
Optionally specifies the order ID of the daily plan order that should be removed.
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
WorkflowPath
-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which daily plan orders should be removed.
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
SchedulePath
-SchedulePath <String>
Optionally specifies the path and name of a schedule for which daily plan orders should be removed.
Required? | false |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
DailyPlanDate
-DailyPlanDate <DateTime>
Specifies the date starting for which daily plan orders should be removed.
Consider that a UTC date has to be provided.
Default: Current day as a UTC date
Required? | false |
Position? | 4 |
Default value | (Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd') |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Remove-JS7DailyPlanOrder -DailyPlanDate "2020-12-31"
Removes any daily plan orders for the given day.
-------------------------- EXAMPLE 2 --------------------------
PS > Remove-JS7DailyPlanOrder -DailyPlanDate (Get-Date).AddDays(3)
Removes any daily plan orders for a date three days from now.
-------------------------- EXAMPLE 3 --------------------------
PS > Remove-JS7DailyPlanOrder -OrderId #2020-11-19#P0000000498-orderSampleWorfklow2a
Removes the given order ID from the daily plan.
-------------------------- EXAMPLE 4 --------------------------
PS > Remove-JS7DailyPlanOrder -WorkflowPath /some_folder/some_workflow
Removes the daily plan orders for the indicated workflow in today's daily plan.