HTTP Response

Overview

The HTTP Response component is used to customize the return information of an API. After a user calls an open API, the user receives the specified Response Body and Response Code.

The HTTP Response component cannot be connected to other components. Therefore, it can be used only as the end node of a task. However, this component is not mandatory. The HTTP Client, Message Logger, and Data Source components can also be used as the end node of a task.

Configuration

Table 1 HTTP Response

Parameter

Description

Response Body

The response body content in the API return information. You can use constants or simple expressions to reference the data on the preceding node. For details about how to reference the data in the preceding node, see Data Reference.

Response Code

The response code in the API return information. You can select an existing response code or customize a response code.

Custom status code

User-defined status code. This parameter is configured only when Response Code is set to Custom.

The Splitter component is an asynchronous processing component.

  • If a Splitter node exists in a task, the open API returns the data transferred to the Splitter node.
  • If an HTTP Response node exists in the follow-up nodes of a Splitter node, the HTTP Response node becomes invalid.