Output Binding

The Output Binding section is critical for defining how the data returned from the API is mapped to specific system fields. This ensures that the API response is interpreted and used correctly within the system.

---

1. Response Construction

Purpose:

• The Response Construction allows you to map the data returned by the API to relevant fields within the system. This ensures that the data from the API can be stored, processed, and displayed correctly based on the requirements of the system.

How to Configure Response Construction:

1. Open the Response Construction Section:

   • In the API Call configuration screen, scroll to the Response Construction section under Output Binding.

2. Define the Structure:

   • The API response should be structured as a JSON object. In this structure, you will map the fields from the API response to the corresponding system fields.

3. Example Response Mapping: If the API response returns customer information, the Response Construction might look like this:

jsonCopy code{
  "status": "success",
  "customer_name": "{{{customer_name}}}",
  "branch_office": "{{{branch_office}}}"
}

• In this example, the response fields customer_name and branch_office will capture data from the API and bind it to the appropriate fields in the system for further processing or display.

---

2. Output Description

Purpose:

• The Output Description explains how the API response is handled and what fields or values are mapped to specific system components. This serves as a form of documentation for other users or developers interacting with the system, providing clarity on how the API data is structured and used.

How to Configure Output Description:

1. Open the Output Description Section:

   • In the API Call configuration screen, scroll down to the Output Description section under Output Binding.

2. Provide a Clear Description:

   • Write a brief, clear description explaining how the API response will be handled and which system fields will be mapped.

3. Example Description:

   • "The API returns customer information, including customer_name and branch_office, which are mapped to the respective system fields for display in the customer profile."

---

Example Setup:

If the API response is:

jsonCopy code{
  "status": "success",
  "customer_name": "John Doe",
  "branch_office": "New York"
}

You could describe how the system will map and display this data:

• "The response will map the customer_name field to the user profile's name section, and the branch_office field will display the branch office associated with the customer."

---

By following this guide, you can effectively set up the Response Construction to handle API data and provide clear Output Descriptions for system documentation.

Let me know if you need further details or clarifications!