X4 Produktdokumentation

Operation: Get Schedule by Id

The Get Schedule by Id operation outputs the scheduler located in the project with the defined Id.

Example

Input

The adapter expects an XML document as input:

XML
<?xml version="1.0" encoding="UTF-8"?>
<Id>f30c0ce7-fbc5-4988-81d4-7de74cb4dca8</Id>

The following elements must be included in the input:


Element

Description

Id

UUID of the project in which the scheduler .schedule is located.

Output

The adapter generates an XML document as output:

XML
<?xml version="1.0" encoding="UTF-8"?>
<Schedule>
   <Id>f30c0ce7-fbc5-4988-81d4-7de74cb4dca8</Id>
   <Cron>
      <Id>6dd6732e-15c1-4a63-bdfd-6d90d45eedb5</Id>
      <Name>Execute every minute</Name>
      <Process>Processes/ScheduledProcess.wrf</Process>
      <Active>true</Active>
      <Expression>0 6 6 ? * FRI *</Expression>
   </Cron>
   <Startup>
      <Id>a0b9dd4d-c722-4aa6-bc07-1f837d52c5d3</Id>
      <Name>Execution</Name>
      <Process>Processes/ScheduledProcess.wrf</Process>
      <Active>true</Active>
      <StartDate>2021-06-29T11:16:09.904+02:00</StartDate>
      <EndDate>2021-07-30T11:16:09.907+02:00</EndDate>
   </Startup>
</Schedule>

The following elements can be included in the output:


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

Name

Name of the execution

Process

Path to the process to be executed

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