Http Client

Perform an HTTP request to a specified endpoint

When to use?

When you want to access data from a web service endpoint

How to use:

  1. Select a Scope type from the drop-down
  2. Scope type installation is for the duration of the whole installation and has the longest life span
  3. Scope type session is for the duration of the session
  4. Scope type request is for the duration of a single request
  5. Select if the result Parameters will be stored as either service or block variables
  6. In the Result name field enter the name the result will be stored under
  7. In the Endpoint URL field enter the URL you wish to send request to
  8. In the Content type drop-down enter the content type you're expecting to get in the headers
  9. In the HTTP method drop-down choose between GET or POST methods
  10. You can cache GET requests by entering a Cache timeout number in seconds
  11. In the Timeout field enter how long should a request wait for a response in seconds
  12. In the Headers field you can add HTTP headers, and in the Parameters field you can add parameters to be sent with the request
  13. You can also send JSON format Request Body in the POST request
  14. The element contains two flows to be executed, depending on the request success: OK and NOK
  15. You can access the result body in the OK flow like this: ${resultName.body.valueYouWantToAccess}
  16. To access the response status code and error messages use this syntax: ${resultName.status}

Example of usage

Accessing horoscope API endpoint and outputting horoscope data: