Lookup Details for REST Service

Specifies the name/value type of the lookup procedure for REST.

Figure: Lookup Details screen

Lookup Details screen

Video: Show Data from a REST Service on an eForm

Examples

Prerequisites

Good to Know

  • 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 a Single Select Lookup Auto Lookup icon control:
      1. On the eForm Builder screen, in the Toolbox, open the Advanced Controls Advanced Controls icon tab.
      2. On the Advanced Controls Advanced Controls icon tab, drag a Single Select Lookup Auto Lookup icon form control onto your eForm.
    • Change a Single Select Lookup Auto Lookup icon control:
      1. On your eForm, click the control, and click Edit Edit icon.
  3. On the Single Select Lookup screen, in the Configure tab, click Add Lookup Add Lookup icon.
  4. On the Select Data Source Type screen, select REST Service REST Service icon.
  5. Click Next.

Fields

Field Name Definition

Advanced Configuration

Function:
Specifies if you want to do a detailed configuration of the REST service.
Accepted Values:
  • Deselected - Does not do a detailed configuration of the REST service.
  • Selected - Does a detailed configuration of the REST service.
Default Value:
Deselected

Access Token

Function:
Specifies the access token that connects to your data source.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Add New Add New icon

Opens this Screen:
Access Token for REST Service
Function of this Screen:
Configure an access token to connect to a REST service.
Example:
Refer to:

Lookup Name

Function:
Specifies the name you want to give to your lookup procedure.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Lookup Type

Function:
Specifies the type of lookup procedure to do.
Accepted Values:
  • Name/Value - The lookup gets data for specified name/value pairs.
Default Value:
Name/Value
Example:
Refer to:

Next

Opens this Screen: