Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Submits daily plan orders To to a number of JS7 Controllers.

The following REST Web Service API resources are used:

* /daily_plan/orders/submit

PARAMETERS

OrderId

-OrderId <String>
Optionally specifies the order Order ID of the daily plan order that should be submitted.

...

-ControllerId <String>
Specifies the Controller to which daily plan orders have been submitted and should be submitted.

Without this parameter daily plan orders are submitted to any Controllers that are deployed the
workflows that are indicated with the respective parameters.

...

-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan orders should be submitted.
Consider that a UTC date has to be provided.

Default: Begin of the The current day as a UTC date in the local time zone

Required?false
Position?7
Default value(Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd')
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-DateTo <DateTime>
Optionally specifies the date until which daily plan orders should be submitted.
Consider that a UTC date has to be provided.

Default: End of the The current day as a UTC date in the local time zone

Required?false
Position?8
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-AuditComment <String>
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, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.

Required?false
Position?11
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.

Required?false
Position?12
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobSchedulerJS7.

This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.

Required?false
Position?13
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

Submits the order with the given order Order ID to the daily plan.

-------------------------- EXAMPLE 4 --------------------------

...