Custom REST connector wizard

Accessing custom REST connector wizard

  1. Go to Projects.
  2. Select a project and click Connectors > REST. The REST Connectors page appears to list all custom REST connectors created.
  3. Click Add Connector. The Add Connector wizard appears.

About the custom REST connector wizard

Based on the custom REST connector creation approach, the Add Connector page appears.
Note: Mandatory fields are marked with an asterisk in the wizard.
Automatic approach
  1. Select source: On the Select source page, you can choose the method for creating and configuring REST connectors. Depending on the method chosen in the Select source page, the subsequent options in the wizard appear.
  2. Configure connector info: You can provide details for your connector such as name, description or icon.
  3. Configure actions: You can configure the actions that are associated with the connector. If you import connector details from a URL or file, the actions in the file or URL are automatically generated and shown on the left side of the page. The details of the selected action are shown on the rest of the page. The REST action is composed of several key components (headers, parameters, request, response) that define how the action is done and what data is involved.
Manual approach
  1. Select source: On the Select source page, you can choose the method for creating and configuring REST connectors. Depending on the method chosen in the Select source page, the subsequent options in the wizard appear.
  2. Define connector: On the Define connector page, provide details such as the connector name, description, icon, and authentication type. You can also configure the following advanced properties:
    • Validate Schema: Controls whether XML schema validation is performed during connector operations, such as import/export and document type generation. This property is enabled by default. Schema validation is currently supported only for SOAP backends. Enabling or disabling this property has no effect on REST connectors as of now.
    • Exclude XML Declaration: Controls whether the XML declaration is included in outbound XML requests. This property is disabled by default. Enable this property only when the target service requires XML requests without the XML declaration "<?xml version='1.0' encoding='UTF-8'?>". This property applies only to XML payloads and has no effect on JSON payload requests.
    Note: You can configure or modify them only after the connector has been created by editing the connector.
  3. Resources: In the Resources page, you can define the details of a resource such as resource path, methods and parameters associated with resource.