HTTP Client

Owned by Pooja Yadav (Deactivated), created
Last updated: Mar 10, 2022 by shreedutta.mukherjee (Deactivated)
3 min read

Introduction

Our HTTP client task enables you to connect to your preferred application present on the web server by providing an API URL. Before establishing a connection, then you need to organize the interaction between both the independent systems by selecting the particular connection type in the configuration.

There are 4 different connection types :

Furthermore, four basic functions can be performed with connected HTTP client known as HTTP methods :

  • Get: Used to retrieve or get the information from the server.

  • Post: Used to send or upload data to the server.

  • Put: Used to update or modify an existing resource present on the server.

  • Patch: Used to update the values of the resource’s properties present on the server.

Data Slots


After you complete the configuration for the HTTP Client task, a fixed set of data-slot gets generated along with the defined data for further use in the automation.

Data slots of the HTTP Client task are as below:

  • Response Header: HTTP headers let the client and the server pass additional information with an HTTP request or response.

  • Response: Content of metafile uploaded by you.

  • Body: Data bytes transmitted in an HTTP transaction.

  • Status: Status codes are issued by the server in response to the client’s request made to the server.

Steps to configure

  1. Drag and drop the HTTP Client task in the automation and click on it. The below form will appear on the right side of the screen.

     

  2. Add name and an appropriate description for reference.

  3. Select the type of connection from the following connection types :

    • 

    • 

    • 

    • 

    Select the existing connection that has been created for the HTTP client or create a new one from the plus button.

  4. Now fill the desired API URL input field. An API URL field is an address that allows you to access an API and its various features.

  5. Select the HTTP method from the following methods: 

    • GET: is used to fetch something from the server

    • POST: helps to create something on the server

    • PUT: helps to update something on the server

    • PATCH: is to delete something from the server

  6. Now choose the request and response content type format. In requests content type, the client commands the server about the desired type of data they wanted to send. on the other hand, the response-content-type command sets the values to allow in HTTP content-type headers.

  7. Add the HTTP headers and query parameter’s key-value pair as per the requirement. The header parameters are used to define user-defined custom HTTP headers for a request. On the other hand, query parameters are a defined set of parameters attached to the end of a URL. They are extensions of the URL that are used to help define specific content or actions based on the data being passed.

  8. Click on save to successfully save the configuration.

  9. Then you can browse files from the output meta section of the form. An Output meta is the type resolution for the result of a component. Each component can provide either static or dynamic metadata for the payload and attributes, isolated from each other.

  10. Add name and file type for reference. A file name is the complete title of a file and file extension.

  11. Click on upload to successfully save the configuration.