Home
Services
Service definitions define REST services and the endpoints of a service. This guide provides step-by-step instructions for creating, importing, and managing services using the system interface, following Microsoft standards.
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.
Create Endpoints
A single endpoint is an API endpoint designed to handle a specific function or request, providing a focused and singular response.
Response
The response definitions for success and error responses.

Services
Service definitions define REST services and the endpoints of a service. This guide provides step-by-step instructions for creating, importing, and managing services using the system interface, following Microsoft standards.
- 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.
  - Create Composite Endpoint
    You can define composite endpoints to call multiple APIs in sequence, passing the output of one API as the input to the next.
  - Create Endpoints
    A single endpoint is an API endpoint designed to handle a specific function or request, providing a focused and singular response.
    - General Information
    - Authentication
    - Request
    - Response
      The response definitions for success and error responses.
- Using service definitions in Link
  Service descriptions can be used in several ways in HCL Link.

Response

The response definitions for success and error responses.

About this task

Fill in the following fields in Success, and Error Response.

Procedure

Type the HTTP status code in Status.
In Content Type, select one of the following content types of the response data.
- application/json
- application/octet-stream
- application/xml
- application/x-www-form-urlencoded
- multipart/form-data
- text/html
- text/plain
Type the data of the response body for a successful response in the Response Body.
Click on Add a row under Output Parameters to fill in the details in the table of output parameters. Elements of response can be assigned to output parameters. Paths are specified using dot notations, for example, address.city. Fill in the following details in each row.
1. Name: The name of the output parameter.
2. Location: Where to get the value of the output parameters from. Select either Header or Body to choose the location of the output parameter.
3. Path: The JSON path of the output field, or the name of the response header.
Click on Add a row to add more values.
Click on Save, to create an endpoint.