Configuring an assembly

An assembly defines the API processing rules to respond to requests.

About this task

To configure an assembly, you must define the assembly rule and how to handle errors that occur during the assembly processing.

An assembly rule can comprise one or more assembly actions to apply to the API call. The assembly actions are run in order and act on different context variables of the API call. You can access and manipulate the variables in the API context by referencing the context variable in the assembly action configuration.

You can define catch settings to handle specific errors. Unhandled errors are saved for preparing the final response. For more information, see Result API action.

You can specify the final API rule to apply to the API call after the main rule, catch rule, or both finish processing. The final API rule comprises only assembly actions.

For assembly actions that call a GatewayScript file, such as the GatewayScript assembly action, you can enable the GatewayScript debugger to troubleshoot the GatewayScript.

Procedure

  1. In the search field, enter assembly.
  2. From the search results, click Assembly.
  3. Click Add.
  4. Define the basic properties - Name, administrative state, and comments.
  5. Specify the assembly rule that consists of one or more assembly actions to apply to the API call.
  6. Optional: Specify a catch setting that defines how to handle a specific error in the assembly.
    1. Click Add.
    2. Enter the name of the error.
    3. Specify an error handler.
    4. Click Apply.
    5. Optional: Repeat the previous steps to add another error case.
  7. Optional: Specify a default error rule to run when an uncaught error occurs.
  8. Optional: Specify the final API rule to apply to the API call.
  9. Click Apply to save changes to the running configuration.
  10. Click Save to save changes to the persisted configuration.