HTTP Query Smart Service

Overview

The HTTP Query smart service allows you to make HTTP requests, suitable for consuming the REST API of an external system. It can perform DELETE, GET, HEAD, OPTIONS, POST, PUT, and TRACE operations and so can be used for both reading data from an external system as well as writing to an external system.

For making REST API requests outside of a process (for example, on a SAIL Dashboard), see:

Properties

  • Category: Connectivity Services

  • Icon: HTTP_Query_ss_icon.png

  • Assignment Options: Unattended/Attended

Node Inputs

Input Data Type Description Required Multiple
Endpoint Text The URL for the request Yes No
Method Text The HTTP method with which to call the url. Available Options: DELETE, GET (the default), HEAD, OPTIONS, POST, PUT, and TRACE Yes No
Headers HttpKeyValuePair A list of headers you wish to send as part of the request. Built with a!httpHeader(). No Yes
Parameters HttpKeyValuePair A list of query parameters you wish to add to the request. Built with a!httpQueryParameter(). No Yes
Basic Authentication HttpAuthenticationBasic The HTTP basic authentication credentials for the request. Built with a!httpAuthenticationBasic(). No No
Request Body Text The request body No No

Node Outputs

Output Data Type Description
Response Body Text The body of the HTTP Response
Status Code Number (Integer) The HTTP status code that was returned. For example, 200 for a successful request.
Response Header Names List of Text A list of the names of the returned HTTP Headers. This a a parallel list to Response Header Values
Response Header Values List of Text A list of the values of the returned HTTP Headers. This a a parallel list to Response Header Names
Error Occurred Boolean true if an HTTP error occurred, otherwise false.
Error Info Text An error message. Only populated when Error Occurred is true

This node does not pause by exception if an HTTP error occurs. You can use the Error Occurred and Error Info outputs to determine how the process handles the error, such as incorporating an escalation into a later part of the process design. This node does not automatically retry failed requests.

Additional Options

See Also

FEEDBACK