Home
Projects
A project is a container for HCL Link artifacts.
Flows
This documentation describes how Flows can be run from REST API, listeners, or they can be scheduled.
Scheduled flows
This documentation describes the options for defining the flow schedule.
Rescheduling a flow
This documentation describes the options available for changing the scheduler settings after a flow is deployed.

Projects
A project is a container for HCL Link artifacts.
- Flows
  This documentation describes how Flows can be run from REST API, listeners, or they can be scheduled.
  - Nodes
  - Terminals
  - Flow terminals
    Flow terminals represent the inputs and outputs to a flow. Every node has input and/or ouptut terminals.
  - Scheduled flows
    This documentation describes the options for defining the flow schedule.
    - Rescheduling a flow
      This documentation describes the options available for changing the scheduler settings after a flow is deployed.
  - Listener
    A Flow that has a Map node as its first node, and uses a File adapter for an input, can enable that node's input to be a Watch.
  - Flow audits
    Flow audits are a way to retrieve more verbose information about a flow instance.
  - Flow variables
    Flow Variables are process data variables that go along with the flow execution, accessible to all nodes in the flow while it is being executed under flow executor/engine context.
  - Create a flow
    Steps required to create a flow.
  - Running flows in the Designer
    When you develop a flow in the Flow Designer you can run the flow directly from the Designer either in Link, or on a different runtime environment.
- Maps
  Maps define input and output specifications and mapping rules for data transformation.
- Schemas
  Use the schema designer to define, modify, and view schemas. A schema describes the syntax, structure, and semantics of your data.
- Connections and Actions
  This documentation describes connections and actions.
- Files
  Files are used in various places within HCL Link. HCL Link allows files to be uploaded to the HCL Linkserver.

Rescheduling a flow

This documentation describes the options available for changing the scheduler settings after a flow is deployed.

In order to change the scheduler settings after a flow is deployed, there are two options.

Change the scheduler settings within the flow settings and then save the flow and redeploy the package containing that flow.
There are two REST endpoints that can be used to modify the scheduler for a flow, or to unschedule the flow so that it no longer runs automatically. These REST endpoints are described here:

REST endpoint 1

POST {host}:{port}/hip-rest/v2/schedule/{path} where {path} is the “URL Path” field for the flow in the package definition which is the name of the flow by default. The body of this POST can include a JSON representation of the scheduler properties. In addition to modifying an existing schedule, this API can be used to schedule a flow that was not originally scheduled.

Below is an example of the JSON payload. Note that for the “days” field the valid values are integers between 1 and 7 with 1 representing Monday and 7 representing Sunday.

{
  "start": "12:00",
  "duration": "10",
  "days": [1,3,7],
  "unit": "hours",
  "interval": 2,
  "end": "20:00",
  "timezone": "GMT",
  "skipifbusy": true,
  "end_date": " 2025-11-18"
}

REST endpoint 2

DELETE {host}:{port}/hip-rest/v2/schedule/{path} where {path} is the “URL Path” field for the flow in the package definition which is the name of the flow by default. Calling this will stop a scheduled flow from executing automatically until its schedule is set again. It has no effect on a flow that is not currently scheduled.