REST

A Representational State Transfer (REST) Application Programming Interface (API) uses HTTP requests to GET A specific letter used by Nintex RPA to communicate with an external application when a Nintex RPA action runs., PUT Rest method used to update information on a web server., POST Rest method used to post information to a web server. and DELETE Rest method used to delete information on a web server. data. The REST action A feature that supplies the instructions in a botflow. executes a call to a REST web service from within a botflow A file that stores the actions and variables designed to automate tasks..

Using the Rest action, you can:

  • Query information from a REST server.
  • Initiate a process using a REST request.

Some examples of using the REST action are:

  • Query for information to update a database.
  • Initiate a process performed on the REST server such as starting an instance of a Nintex Workflow Cloud workflow.

Add a REST action to a botflow

These are the steps required to add a REST action to a botflow. The Action Builder field and button descriptions table given below the procedure fully describe required and optional configuration fields.

To add a REST action to a botflow:

  1. On the Actions List, click Advanced and then click REST from the Programming list.
  2. The Action Builder window for REST displays.

  3. Set the REST settings.
  4. General

    • Type: Select the required REST method needed to invoke the web service from the drop-down list.
    • Url: Specify the URL, starting with https://, and enter the remainder of the web address.
    • Headers: Add any required headers by clicking the plus sign () and completing the fields in the Header window.
    • Body: When the POST, PUT, DELETE, or OPTIONS methods are selected, specify the body of the request that will be sent to the web service.
    • Encoding: Select the required encoding from the drop-down list.

    Authentication

    • Authentication: If required, select the Authentication check box and then select the required authentication type from the drop-down list.

    Response

    • Save content: Select the required option to save the content of the REST action:
      • File: Enter the file name with file path in the field.
      • Variable: Enter the variable name in the field.
    • Save status code: If required, select the Save status code check box to enter a code in the Save status code field.

  5. If needed, adjust the Run Error Task settings to fine tune how the action runs.
  6. If needed, adjust the Run Switch setting to create the action without running it.
  7. Optionally, add an action note.
  8. Click OK to add the REST action to the botflow.