Operation: Update Schedule | X4Documentation

The Update Schedule operation updates the scheduler located in the project with the defined ID.

Note:

The changes are updated only at runtime and are stored in a .runtime file. The .schedule file in the repository is not updated. For more information, see Using Runtime Configurations.

Example

Input

The adapter expects an XML document as input.

XML

<?xml version="1.0" encoding="UTF-8"?>
<Schedule>
  <Id>f30c0ce7-fbc5-4988-81d4-7de74cb4dca8</Id>
    <Cron>
      <Id>6dd6732e-15c1-4a63-bdfd-6d90d45eedb5</Id>
      <Expression>0 6 6 ? * FRI *</Expression>
    </Cron>
</Schedule>

The following elements must be included in the input:

Element	Description
Id	UUID of the project in which the scheduler `.schedule` is located.
Cron	Execution type `Cron`
Startup	Execution type `Startup`
Startup:Id	UUID of the execution
Cron:Id	UUID of the execution
Active	Execution status Possible values: `true` / `false`
CronExpression	Cron expression of the execution, only relevant for the execution type `Cron`
StartDate	Start date of the execution, only relevant for the execution type `Startup`
EndDate	End date of the execution, only relevant for the execution type `Startup`