Welcome > Process Designer module > Activity types > Other activities > RESTful Service activity > Configure a RESTful Service activity

Configure a RESTful Service activity

To use RESTful Service activities, you must first set up a RESTful Service reference. See Create a Web Service Reference.

  1. Add a RESTful Service activity to the map. See add an Activity.
  2. On the Extended Properties page of the RESTful Service activity, click the Configuration tab.
  3. Consume the required preconfigured RESTful web service reference in the Web Service box.

    Depending on the selected RESTful service, the base URL appears in the Base URL box.

    Note You can whitelist a web service reference. If Allow All in the system settings is set to No, you can only use the whitelisted web service references. See Configure the server URLs and database connection strings.
  4. If required, specify the URL parameters (which are optional parameters of type String that influence the returned results) by doing one of the following:

    • To provide static parameters, enter the required text in the URL Parameters box.

    • To dynamically get the relevant information at the time of execution and display it to the user at runtime, consume the required variables in the URL Parameters box.

    • Use a combination of static text and dynamic values in the URL Parameters box.

    Note You can reuse the base URL parameters by copying and pasting it in the base URL parameters of another restful services.
  5. On the Type list, select XML or JSON.
  6. On the Verb list, select the action to perform.

    Select GET.

    To map the output, do either of the following under Response:

    • Click Variable and map the entire output to a single variable of type String or XML by consuming the variable in the Value box.

    • Click Expression and define the elements to extract from it by providing the correct path in the Path box. Or, consume the required variable in the Value box, and click the Add button.

    Select PUT (to update) or POST (to insert).

    In the Request box, specify the dynamic input by either mapping the entire input to a single String or XML variable or dynamically defining a combination of static text and variables.

    Note You can reuse the request by coping and pasting it in PUT and POST verb of another restful service.

    Select DELETE.

  7. You can also select how to handle the returned status code. To specify if a job should be suspended if an error is found, do either of the following:

    • To allow the job to be suspended if an error is found, click Yes for Suspend Job on Error.

    • To allow the job to be completed even if an error is found and to display the error code, click No for Suspend Job on Error, and then consume the required variable in the Error Code box. This helps a user handle errors manually.

  8. Click Save.