The OPTIONS action sends an HTTP OPTIONS request to a REST service.
Use the OPTIONS action to retrieve information about the communication options supported by a REST endpoint. An OPTIONS request does not retrieve or modify a resource. Instead, it returns metadata describing which HTTP methods, headers, and operations are available for the endpoint. OPTIONS requests are commonly used to validate endpoint capabilities, diagnose integration issues, and understand how a REST service expects requests to be structured.
An OPTIONS request is sent to a REST endpoint and returns information about the capabilities of that endpoint. An OPTIONS request does not typically return resource data. Instead, it returns metadata in the response headers. The response may include information such as supported HTTP methods, allowed request headers, supported content types, or cross-origin resource sharing (CORS) settings. The exact response depends on the implementation of the target REST service.
The input parameters for OPTIONS are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| restUrl | String | Required | The URL of the REST service endpoint to call, 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 defined 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 from OPTIONS 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. |