Home
Runtimes
Descriptions of Link runtime services.
REST API
The REST Runtme provides a REST API used to run maps and flows that have been deployed.
V2 REST API
The V2 API allows packages built in the HCL Link web UI to be deployed to a runtme server.

V2 REST API

The V2 API allows packages built in the HCL Link web UI to be deployed to a runtme server.

When deployed, any maps or flows contained in the package can be run. There are three ways that flows can be invoked:

Flows can be directly invoked - as long as URL is provided when creating the package. The URL is automatically included for any maps or flows selected to be in the package. It has to be manually removed for a map or flow if it is not intended to be run directly.
Flows can be scheduled to be run based on the time.
Flows can have a watch set up to trigger the flow based on an event, such as when a file is created in a specified directory.

Maps can only be run directly. They cannot be scheduled, or have a watch set.