The PUT action sends an HTTP PUT request to a REST service.
Use the PUT action to replace or update an existing resource in an external system. A PUT request sends data to a specific resource and typically updates its current state using the information provided in the request payload.
PUT supports JSON payloads, form data, and binary content.
Use the PUT action when you need to:
- Update an existing record.
- Replace an existing resource with new data.
- Update document metadata or business information.
- Upload a revised version of a file.
- Synchronize process data with an external system.
PUT request sends information to a specific REST endpoint. The request can include URL parameters, request headers, and r request body (payload). The external service processes the request and returns response data, HTTP status code, and response headers. The returned values can be mapped to process variables and used in later process steps.
The input parameters of the action 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. |
| requestPayload | JSON | Optional |
The body of the request. You can choose from the following options:
The downstream application validates Content-Type strictly and rejects requests with generic or mismatched types. The pre-selected option depends on the requestHeaders value. |
| 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 PUT are:
| Parameter | Type | Required | Description |
|---|---|---|---|
| restResult | JSON | Optional | The response data returned by the REST service. The format and contents depend on the endpoint being called and can be mapped to process variables for use elsewhere in the process. |
| 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. |