RESTCall Step
Description:
This step makes a REST call and returns the result in JSON or XML.
Inputs
- restURL – URL to call
- method – http method to use, Get, Post, Put, Delete
- username – authentication user name
- password – authentication password
- payLoadType – XML, JSON, FormURL or FormData
- requestBody – JSON or XML body
- responseType – return type JSON or XML
- sourceFilePath – file path to upload
- headers – custom headers to add
- varToStoreResult – variable to store the response
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
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. Click the process step to view its properties. The step should fetch and store the access token in a variable or global, as configured.
Definition Sample:
You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after the import. Then, save the definition to confirm the changes.