Introduction

The API Connector Process Tool plugin allows you to integrate external APIs into a process.

Get started

1. In Process Builder, click the Tool component in the participant track.
2. For Tools, select API Connector from the drop-down list.
3. Configure the API connector properties and click Apply Change.

Properties configuration

• API Connector: Select the API connector created.
• Select Operation: Select the operation created in the API Connector Builder.
• Depending on the HTTP method of the operation, configure:
  
  • id
  • Payload

• Form: Select a form to store the data to.
• Base JSON Object Name for Multirow Data: Select the name of the base JSON object (e.g., name).
• Field Mapping: Allows for manual mapping of a field name to a JSON object name if the names are different.
  • FIELD NAME
  • JSON OBJECT NAME
• Workflow Variable Mapping, click Add and configure the following:
  • Workflow Variable
    • Status (Create Account)
    • status (basicinfo Approval Process, basicinfo Approval Approval Process)
  • JSON Object Name

Related documentation

• Bean Shell for Process Tool
• Process Tool & Post Form Submission Processing Plugin