Configure General Options for the REST Service

To configure the REST service, do the procedure in this topic.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Web Services Web Services icon tab.
      2. On the Web Services Web Services icon tab, drag the REST Service REST Service icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. On the General Configuration screen, in the Display Name field, enter the name you want to show in your process.
  2. (Optional) In the Description field, enter more than one line of text description for your activity.
  3. (Optional) In the Connection Timeout (Seconds) field, specify the time limit, in seconds, for the session to complete the activity.