Description:

The RestCall workflow step makes a REST call to a specified URL and stores the resulting response in a Variable or Global variable. The step supports selecting the REST method, configuring authentication information, specifying a payload type and request body, configuring the expected response type, mapping request headers, and optionally providing a source file path for file upload scenarios.

The step supports:

• REST API calls
• Configurable REST call methods
• Authentication username and password
• Configurable payload types
• Request bodies
• JSON or XML response handling
• Request headers
• Source file upload
• Storing the REST response in a Variable or Global variable 

This step can be used for:

• Integrating with external REST APIs
• Retrieving data from external systems
• Sending data to external services
• Connecting workflow processes to third-party applications
• Submitting structured request payloads
• Uploading files to REST endpoints
• Passing API responses to subsequent workflow activities

Usage:

The RestCall step is typically placed where a workflow needs to communicate with an external REST service.

The REST URL and method identify the request being made. Optional authentication information, payload configuration, request body, headers, and source file information can be provided according to the REST endpoint's requirements. The response is configured using the response type and stored in the specified Variable or Global variable.

A typical workflow pattern is:

Prepare Request → RestCall → Process Result

The resulting value can then be used by later workflow steps to:

• Populate Variables.
• Process API response data.
• Make decisions based on returned information.
• Prepare data for another workflow activity.
• Send information to another external service.
• Continue an integration workflow.
• Store or otherwise process the returned JSON or XML.

Typical Workflow Suggestions:

Retrieve Data from an External REST Service

Use the RestCall step when a workflow needs to retrieve information from an external REST endpoint.

A typical pattern is:

Prepare URL/Parameters → RestCall → Process Response

Store the returned result in a meaningful Variable or Global variable so that downstream steps can use it.

Send Data to an External API

Use the requestBody input to provide data that needs to be submitted to the REST service.

A typical pattern is:

Build Request Data → RestCall → Process API Result

The request body can contain workflow-generated content appropriate for the selected REST method and payload configuration. The exact request-body format should match the requirements of the target REST service.

Configure Request Headers

Use the Headers configuration when the REST service requires specific request headers.

For example, a workflow may need to provide headers required by the target service before the request is executed. The XML defines this input as RequestHeaders, whose purpose is to map request headers.

Process JSON or XML Responses

The step is defined as making a REST call and returning JSON or XML. Configure the responseType input according to the response expected from the endpoint, then store the result in the configured Variable or Global variable.

A typical pattern is:

RestCall → Store Result → Process Response

Upload a File

Use sourceFilePath when the REST request involves uploading a source file.

A typical pattern is:

Create/Locate File → RestCall → Process Result

The XML specifically identifies this input as the Path of the source file to be uploaded.

Use Authentication Inputs

When the target service requires authentication information, the userName and password inputs can be configured.

Do not assume a particular authentication scheme solely from these property names. Confirm the authentication mechanism supported by the target REST endpoint and the FlowWright implementation before configuring production workflows.

Store the Result for Reuse

The REST response is explicitly configured to be stored in a Variable or Global variable.

A typical pattern is:

RestCall → Store Result → Multiple Subsequent Steps

Use a meaningful result variable name so that downstream workflow designers can easily identify the API response.

Example:

Let’s build and execute the “RESTCallDef” example.          

• Create a new process definition named “RESTCallDef” and open it in designer mode. 
• Drag a “RESTCall” step to the canvas. 
• Connect the dots between the “Start” and “RESTCall” steps, as shown above. 
• Define a variable or a global to store the results.
• Click the "RESTCall" step to configure its "Required" properties. Provide a name for the step. Enter the REST call URL. Select the REST call method (Get, Post, Put, Delete, Patch). Specify the variable or global reference to store the result. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the "RESTCall" step to configure its "Optional" properties. Provide the authentication username and password. Select the payload type (the name of the step). Provide the REST call URL. Select the REST call method (XML, JSON, FormURL, Formdata). Select the response type (XML, JSON, Formdata). Provide the server file path of the source file to upload. Click the Save button. 

• Click “Headers” to configure the key and value parameters. Click the Add Row (+) button to insert an empty row. Enter the key and value parameters. Click the Save button. You may add multiple headers using the Add Row button.  

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. Render the process instance and select the Rest Call step to view its properties. When the workflow reaches the RestCall step, it uses the configured REST URL and method and applies the configured request options. The resulting response is stored in the specified Variable or Global variable. The step then provides the True and False workflow paths for subsequent processing.

Tips:

• Use a meaningful Variable or Global variable name for the REST result.
• Verify the REST URL before executing the workflow.
• Select the REST method required by the target endpoint.
• Configure request headers explicitly when they are required by the REST service.
• Provide a request body only when required by the endpoint.
• Select a payload type appropriate for the request being sent.
• Select a response type appropriate for the response the service returns.
• Test the REST call with representative request data before deploying the workflow.
• Verify the stored result before using it in downstream workflow activities.
• When uploading a file, verify that the configured source file path is available when the step executes.
• Test authentication configuration separately before using the REST call in a production workflow.
• Connect the False return path to appropriate alternative or error-handling logic.
• Test the workflow after changing the REST URL, method, headers, payload, or response configuration.
• Do not assume specific HTTP status-code handling, authentication behavior, timeout behavior, retry behavior, or response parsing behavior unless confirmed by the FlowWright implementation.
• Do not assume the availability of REST methods, payload types, or response types without checking the options available in the current FlowWright installation.
• Keep sensitive credentials out of workflow-generated text and logging.

Notes:

• The RestCall step is defined in the WebServices category with the internal name restcall, label “Makes a REST call and returns JSON or XML”, and display name “Rest Call.” It is implemented by FlowWright.Workflow.RESTCall in FlowWright.Workflow.dll and is defined as a Process step with 2 incoming connections and 2 outgoing connections.
• The step defines three required properties:
  • restURL – REST call URL
  • method – REST call method
  • varToStoreResult – Variable/Global to store the result
• The remaining properties are optional:
  • userName
  • password
  • payLoadType
  • requestBody
  • responseType
  • sourceFilePath
  • headers 
• The step uses the following FlowWright data types:
  • multilineTextBox – FlowWright.DataTypes.ClsMultilineBox
  • RestMethods – FlowWright.DataTypes.RestMethods
  • string – FlowWright.DataTypes.ClsTextBox
  • PayLoadType – FlowWright.DataTypes.PayLoadType
  • ResponseType – FlowWright.DataTypes.ResponseType
  • RequestHeaders – FlowWright.DataTypes.RequestHeaders 
• The step provides two return values:
  • False
  • True

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into your FlowWright Process Definition XML or Form Definition HTML page.

Note: Verify and complete any missing configuration after importing a sample, including:

• REST call URL.
• REST call method.
• Authentication settings, if required.
• Payload type.
• Request body.
• Response type.
• Source file path, if applicable.
• Request headers.
• Variable or Global variable used to store the result.
• Workflow Variable references.
• Environment-specific REST endpoint settings.
• Downstream True and False workflow paths.

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.