Updated on 2023-09-20 GMT+08:00

Interface Invoking

Diagram Element

Parameter Description

The following figure shows the parameters of the Business Invoke diagram element.

The parameters are described as follows:

  • Module Description: diagram element name to be displayed, which can be customized as required.
  • Select Interface: You need to select an interface name from the drop-down list box. The interfaces that can be selected have been configured for the current tenant. For details about the interface configuration, see Configuring an Interface.
  • Input Parameter: This area displays the input parameters of the selected interface. When there are specific input parameters, constants and variables can be combined, for example, id ${FLOW.ID}. You can also assign values to input parameters. The values can be constants and variables. Note that the input variables such as FLOW.ID must be defined in the system.
  • Output Parameter: This area displays the output parameters of the selected interface. If an output parameter exists, you can assign a value to the output parameter as required. In the dialog box that is displayed, select Global Variable or Flow Variable. The system automatically filters global variables or flow variables of the corresponding type based on the output parameter type defined in the interface. When the value is obtained from the interface, JSON data nesting is supported. The value is obtained in the result.name result.id format.
  • Click Save to save all parameters set on the current page.

Typical Application Scenarios

This diagram element is used to invoke an interface.