The HEAD action is used to send HTTP HEAD requests.
The input parameters for HEAD are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| restUrl | String | Required | URL of the REST endpoint including the protocol and path, for example: http://hyland.com |
| restUrlParams | JSON | Optional | JSON map of the URL parameter names and values to append to the URL |
| restUrlEncoded | Boolean | Optional | Determines whether to encode the URL, for example: true |
| requestHeaders | JSON | Optional | A JSON map of the request header names and values. Values can be fixed values or variables. |
| circuitBreaker | Boolean | Optional | Determines whether the circuit breaker is enabled, for example: true |
| timeout | Integer | Optional | The timeout period to wait for the service in milliseconds, for example: 910000 |
The output parameters from HEAD are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| restStatus | Integer | Optional | The HTTP response status code from the REST service call |
| responseHeaders | JSON | Optional | The HTTP response headers from the REST service call |