Skip to main content
Feedback

HTTP PATCH Client (Deprecated) operation

The HTTP PATCH Client (Deprecated) operation determines how to interact with the HTTP service defined in the HTTP PATCH Client (Deprecated) connection.

note

The REST Client connector should now be used for PATCH functionality. For a comparison of the REST Client connector and the HTTP Client connector functionality, see this Community article.

The operation supports one action:

  • PATCH — send HTTP requests supporting the PATCH method to update and make partial changes to an existing resource without replacing the original version of the resource.

    • Make sure and specify the resource path (required) in the Set Properties step (Path document property) for the input document to the connector. By specifying the required Path document property, you help ensure that the connection works as expected and does not encounter errors. The connector sends HTTP PATCH requests to the service based on the Base URL from the connection and the resource path from the Path document property.

    • Data passed into the HTTP PATCH Client (Deprecated) connector (for example, a user's name in the Message step) is included and set in the payload of the Request.

    • The connector returns an unstructured document as output from the operation.

    • You can specify HTTP request headers using dynamic document properties. Properties having the prefix inheader_ are included in the HTTP request. The connector ignores and does not include other properties in the request, but attaches the properties in the output document.

Options tab

When you configure a PATCH action, the following fields appear on the Options tab:

Tracking Direction - Select the document tracking direction for the operation, either Input Documents or Output Documents. This setting enables you to choose which document appears in Process Reporting. Start steps always track output documents regardless of your selection.

note

If the tracking direction is read-only, the feature to change the direction is either unavailable or the developer set the configuration to read-only. The default value you see shows you which document appears in Process Reporting.

Response Profile - Select or add an XML profile component that represents the structure received by the connector.

Return Application Error Responses - This setting controls whether an application error prevents an operation from completing:

  • If you clear the setting, the process stops and reports the error on the Process Reporting page.
  • If you select the setting, processing continues and passes the error response to the next component processed as the connection output.

Archiving tab

See the topic Connector operation’s Archiving tab for more information.

Tracking tab

See the topic Connector operation’s Tracking tab for more information.

Caching tab

See the topic Connector operation’s Caching tab for more information.

On this Page