Home
Design concepts
Learn about HCL Link services, projects, flows, maps and schemas.
Services
Service definitions define REST services and the endpoints of a service.
Defining endpoints
An endpoint can represent either a single API call or it can be a composite endpoint whereby multiple endpoints can be called in sequence.

Design concepts
Learn about HCL Link services, projects, flows, maps and schemas.
- Introduction
  The documentation provided here defiens the main artifacts in HCL Link. It is necessar to understand what these artifacts are and the relationship between them.
- Services
  Service definitions define REST services and the endpoints of a service.
  - Defining a service
    A service can be defined in HCL Link in a number of ways.
  - Defining endpoints
    An endpoint can represent either a single API call or it can be a composite endpoint whereby multiple endpoints can be called in sequence.
    - Request
      Defines the endopoint of the API call.
    - Success and error response
      The response definitions for success and error responses.
    - Composite endpoints
      Composite endpoints can be defined which all for multiple APIs to be called in sequence and for outputs from one API to be passed as an input to a subsequent API.
  - Using service definitions in Link
    Service descriptions can be used in several ways in HCL Link.
- Projects
  A project is a container for HCL Link artifacts.
- Flows
  A HCL Link flow is a transactional data flow comprised of processing nodes.
- Maps
  A HCL Link map defines how to generate data that complies to a specific schema. A map can have any number of inputs and outputs.
- Schemas
  Schemas specify the format of data witin HCL Link maps and flows.
- 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.
- Flow variables
  Flow variables provide a means of passing information throughout a flow instance without requiring that the information to be passed through data links. flow variables are name-value pairs that persist, unless deleted.
- Cache variables
  Cache variables provide a means of processing information throughout a flow instance without requiring that the information to be passed through data links.

Defining endpoints

An endpoint can represent either a single API call or it can be a composite endpoint whereby multiple endpoints can be called in sequence.

An endpoint ins defined within a specific service and is created if a service definition is imported.

An endpoint contains this information:

Name - the unique identifier of the endpoint.
Description - information that describes the purpose of the endpoint.
Category - can be used to group together related endpoints.
Request - details about the request.
Success and error response - details about the success and error response.

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.