Welcome > Workflow > Business processes > Design a basic process > Activity > Activity types > Other activities > RESTful service activity > Configure a RESTful service activity

Configure a RESTful service activity

Use a RESTful Service activity to configure the document set related activities within a process.

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

  1. Add an activity to the map.

    By default, the Configuration tab is open in the properties panel of the activity.

  2. Change the default Name of the activity to something meaningful.
  3. On the Type list, select Other > RESTful service.
  4. On the Web service list, select the preconfigured RESTful web service reference as needed.

    Depending on the selected RESTful service, the Base URL appears. Additionally, the custom headers that are defined in the RESTful service appear under Custom header.

    Note You can whitelist a web service reference. If the Allow all system setting is not selected, you can only use the whitelisted web service references. See Configure the server URLs and database connection strings.
  5. 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, right-click in the URL parameters rule editor and select the process or server 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.
  6. On the Verb list, select the action to perform. (Default: GET)

    GET or DELETE

    Select GET to retrieve the data, and DELETE to delete the data, and perform the following steps.

    • Select the Type as XML or JSON. (Default: XML)

    • The custom headers defined when creating a web service reference and their default values are displayed under Custom header. To edit the default value of a custom header, do the following:

      1. Double click the row or select the row and click .

      2. For Value, select a dynamic variable or click and enter a static value.

      3. Click OK.

        When a job is created on the process, the custom values defined are passed to the Third party web service. If no mapping or inline value was provided in the activity, the default value defined in the RESTful service definition is used.

    • Select either of the following on the Response type list:

      • Select Variable (default) and map the entire output to a single variable of type String or XML by selecting a process or server variable on the Value list.

      • Select Expression and do the following:

        1. Click .

        2. To define the elements to extract from the expression, provide the correct Path.

        3. On the Value list, select a process or server variable.

        4. Click Add.

    POST or PUT

    Select POST to insert the data, and PUT to update the data, and perform the following steps:

    • Select the Type as XML or JSON. (Default: XML)

    • Right-click in the Request rule editor and select a process or server variable.

    • The custom headers defined when creating a web service reference and their default values are displayed under Custom header. To edit the default value of a custom header, do the following:

      1. Double click the row or select the row and click .

      2. For Value, select a dynamic variable or click and enter a static value.

      3. Click OK.

        When a job is created on the process, the custom values defined are passed to the Third party web service. If no mapping or inline value was provided in the activity, the default value defined in the RESTful service definition is used.

    • Select either of the following on the Response type list:

      • Select Variable (default) and map the entire output to a single variable of type String or XML by selecting a process or server variable on the Value list.

      • Select Expression and do the following:

        1. Click .

        2. To define the elements to extract from the expression, provide the correct Path.

        3. On the Value list, select a process or server variable.

        4. Click Add.

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

  7. To specify how to handle the returned status code, do either of the following for Suspend job on error. (Default: Clear)

    • Keep the Suspend job on error check box clear and select the select a process or server variable on the Error code list.

      The job will be completed even if an error is found and the selected error code is displayed at runtime. This helps a user handle errors manually.

    • Select Suspend job on error.

      The job is suspended if an error is found.

  8. Save the process map.