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.
V1 REST API
The V1 API has two different modes it can use to run maps. It can run maps directly, or it can run cataloged maps.
V1 map catalog API
The V1 API allows maps to be cataloged by calling POST/v1/hip/catalog.

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.
  - V1 REST API
    The V1 API has two different modes it can use to run maps. It can run maps directly, or it can run cataloged maps.
    - V1 map direct run API
      In order to run maps directly, the .mmc file for the map must be placed in one of the directories defined for the map .dirs property in the config.yaml.
    - V1 map catalog API
      The V1 API allows maps to be cataloged by calling POST/v1/hip/catalog.
- Flow Command Server
  Deploy a flow from the HCL Link to the local filesystem using Execution flow server definition.
- Map Command Server
  To use the Map Command Server to execute a map, you will prepare the maps for execution.
- SDK
  The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.

V1 map catalog API

The V1 API allows maps to be cataloged by calling POST/v1/hip/catalog.

Before a map can be cataloged it must be placed in one of the directories defined for the map.dirs property in the config.yaml file.

Information about the map can be specified in the JSON payload and that information will be visible in the Swagger page at the following location:

{host}:{port}/hip-rest/api-docs?url=v1/hip/docs

The map can then be run using the endpoint /v1/hip/maps/catalog/{path} with either a PUT action, or a POST action, where a PUT will run it synchronously and a POST will run it asynchronously. The {path} refers to the url_path field that was provided when cataloging the map.