RESTCall Step

Last published at: May 14th, 2024


Makes a REST call and returns JSON or XML


  • 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 


  • True – step executed successfully
  • False – step failed to execute 



Let’s build and execute the RESTCallDef example.          

  • Create a new definition called “RESTCallDef
  • Select the definition and click the “design” button
  • Drag a RESTCall step from the toolbox
  • Connect the dots between the start and RESTCall step

  • Click on the “RESTCall” step to configure its properties
  • Configure the following values for the properties as shown on the below graphic
  • Define headers

  • Click the “save” button
  • Save the workflow definition, create a workflow instance and execute. Step should get access token and store into variable/global.