The HEAD action sends an HTTP HEAD request to a REST service.
You can use the HEAD action to retrieve information about a resource without downloading the response body. A HEAD request returns the same response metadata as a GET request, including the HTTP status code and response headers, but does not return the resource data itself.
A HEAD request is processed similarly to a GET request, but only returns response metadata. The response typically includes: HTTP status code and response headers.
Because the resource content is not returned, HEAD requests can be useful when working with large files or resources where only metadata is required.
The input parameters of the action are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| restUrl | String | Required | The URL of the REST service endpoint, including the protocol and resource path, for example:http://hyland.com |
| restUrlParams | JSON | Optional | A JSON object containing query parameter names and values to append to the request URL.
Use this property to pass values such as filters, search criteria, or
identifiers. For example:{
"status": "active",
"page": "1",
"pageSize": "50"
}
|
| restUrlEncoded | Boolean | Optional | Specifies whether the URL should be URL-encoded before the request is sent. Enable this option when the URL contains special characters that require encoding. |
| requestHeaders | JSON | Optional |
A JSON object containing request header names and values. Headers can be used to provide authentication information, specify content types, or include additional request metadata. Values can be fixed values or process variables. The available request headers are defdined in the API documentation for the endpoint that REST is calling. |
| circuitBreaker | Boolean | Optional | Enables or disables circuit breaker protection for the request. When enabled, the connector can prevent repeated calls to an unavailable service and help improve process resilience. |
| timeout | Integer | Optional |
The timeout period to wait for the service in milliseconds. The default timeout is 30 000. |
The output parameters of the action are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| restStatus | Integer | Optional | The HTTP status code returned by the REST service. Use this value to determine whether the request completed successfully and to support conditional process routing or error handling. |
| responseHeaders | JSON | Optional | The HTTP response headers returned by the REST service. Response headers contain metadata about the response, such as content type, caching information, security policies, and resource details. |