Skip to end of metadata
Go to start of metadata

Flows are acyclic directed graphs of operational nodes which are composed of inputs, logic, and outputs. They are used by endpoints, which require them for their runtime functionality of taking inputs and turning them into responses when an endpoint is hit. For reference information on flow orchestration, refer to Flow Orchestration.

Add API endpoints

To import and add API endpoints and flows, refer to Manage Endpoints.

View flows

To view a flow using the API Builder GUI:

  1. Select the  API Doc & Test tab.
  2. Select an API Endpoint to view the API List of endpoints. The API Lists page is displayed. Endpoints that are flow-based have a Flow icon displayed. Endpoints that are programmatically-based do not have a Flow icon display. Additionally, the method, path, nickname, description, and status of each endpoint is provided on the APIs List page.
  3. Select the Flow icon for the endpoint flow you want to view. The selected flow is displayed in the flow editor panel on the API Orchestration user interface.
  4. To exit the API Orchestration user interface and return to the API Lists page, select Cancel.

Create flows

To create a flow using the API Builder GUI:

  1. Import an API endpoint per the Add endpoints instructions in Manage Endpoints. Once the API endpoints are imported and the server is restarted, the imported API endpoints are displayed on the APIs List page. The imported API endpoints are disabled and each endpoint has Create Flow and Delete icons. Additionally, the method, path, nickname, description, and status of each imported endpoint is provided on the APIs List page.
  2. Click the Create Flow icon for an endpoint. The API Orchestration user interface is displayed and a Start node is presented in the flow editor panel.
  3. Add nodes to the flow. Refer to the Add node instructions in Manage Nodes.
  4. Configure the nodes added to the flow. Refer to the Configure node instructions in Manage Nodes.
  5. Connect the nodes in the flow. Refer to the Connect nodes instructions in Manage Flows.
  6. When the flow is complete, click the Save button. The Flow save caution window is displayed. Note: Only valid flows can be saved.
  7. Select Proceed to save the flow. Select Cancel to return to the API Orchestration user interface. If Proceed is selected, the server is restarted and the flow is saved. Once the server restart is completed, the APIs List page is displayed and the flow is enabled. For flow creation examples, refer to Flow Examples.

Edit flows

To edit a flow using the API Builder GUI:

  1. Select the  API Doc & Test tab.
  2. Select an API Endpoint to view the API List of endpoints. The API Lists page is displayed.
  3. Select the Flow icon for the API endpoint flow to edit. The selected flow is displayed in the flow editor panel on the API Orchestration user interface.
  4. Make the required edits to the flow. For instructions on adding, configuring, and connecting nodes or disconnecting and deleting nodes, refer to Manage Nodes.
  5. Once the flow edits are completed, click the Save button. The Flow save caution window is displayed.
  6. Select Proceed to save the flow. Select Cancel to return to the API Orchestration user interface. If Proceed is selected, the server is restarted and the flow is saved. Once the server restart is completed, the APIs List page is displayed.

Delete flows

To delete a flow using the API Builder GUI:

  1. Select the API Doc & Test tab.  
  2. Select an API Endpoint to view the API List of endpoints. The API Lists page is displayed.
  3. Select the Delete icon for the API endpoint to delete. The Endpoint delete caution window is displayed.
  4. Select Proceed to the delete the selected API endpoint. Select Cancel to return to the APIs List page. If Proceed is selected, the endpoint and any associated flow are deleted and the server is restarted. Once the server restart is completed, the APIs List page is displayed.
  • No labels