Auto-Lookup > REST > Name/Value

This topic shows how to create a lookup with REST as the data source based on a name/value pair for the Auto-Lookup form control.

Background and Setup

Video: Show Data from a REST Service on an eForm

Examples

Good to Know

  • There is more than one path to configure a lookup. Make sure you use the document that shows the path for your lookup.
  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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 Auto-Lookup form control configuration screen, on the Configure tab, click Add Lookup.

    For information about how to open this screen, refer to Auto-Lookup form control.


    Click Add Lookup
  2. On the Select Data Source Type screen, select REST Service.

    Select REST Service
  3. Click Next.

Lookup Details

Specifies the basic configuration for a lookup.

Figure: Lookup Details screen

Lookup Details screen

Good to Know

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.
  • Multiple Columns - The lookup gets data for more than one column.
Default Value:
Name/Value
Example:
Refer to:

Configure Lookup > Advanced Configuration tab

Configures a lookup in details for the REST service.

Figure: Configure Lookup > Advanced Configuration tab

Advanced Configuration tab

Fields

Field Name Definition

Request URL

Function:
Specifies the REST service URL for your method.
Accepted Values:
A valid REST service URL.
Default Value:
None

Action

Function:
Specifies the type of action for the REST service to do.
Accepted Values:
  • POST
  • GET
  • DELETE
  • PUT
  • PATCH
Default Value:
GET

Content Type

Function:
Specifies the type of content the REST service uses.

JSON or XML patch files are also supported to patch the document with the specified changes.

Accepted Values:
  • XML
  • JSON
Default Value:
JSON

Accept

Function:
Specifies the data format to accept in a REST service.
Accepted Values:
  • XML
  • JSON
Default Value:
JSON

Protocol

Function:
Specifies the communication protocol for your REST service.
Accepted Values:
  • HTTP 1.0
  • HTTP 1.1
Default Value:
None

Request Timeout (sec)

Function:
Specifies the maximum amount of time, in seconds, to complete the REST service call for the activity.
Accepted Values:
An integer, representing a number of seconds.
Default Value:
60

Read-Write Timeout (sec)

Function:
Specifies the maximum amount of time, in seconds, for read and write methods.
Accepted Values:
An integer, representing a number of seconds.
Default Value:
60

Header Information

Function:
Specifies the custom headers for the REST service.

Request headers are usually used to give security information, such as authentication credentials.

Accepted Values:
  • Name
  • Value
Default Value:
None
Accepts Process Data Variables:
Yes

Authentication

Opens this Screen:

Configure Lookup > Basic Authentication tab

Creates REST service authentication credentials to connect to a REST service URL with basic authentication.

Figure: Configure Lookup > Basic Authentication tab

Basic Authentication tab

Fields

Field Name Definition

User Name

Function:
Specifies the user name for REST service authentication.
Accepted Values:
A valid user name.
Default Value:
None
Example:
Refer to:

Password

Function:
The password for the authentication account.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Process Data Variables:
No

Authorization

Function:
Specifies an authorization value to connect to the REST service.
Accepted Values:
A valid authorization value.

When you click Generate button, this field completes.

Default Value:
None

Generate

Function:
Gives the authorization value to connect to the REST service.

Insert

Function:
Adds the authorization name and value in the Header and Value field.

Reset

Function:
Deletes the REST service authentication credentials.

Configure Lookup > OAuth 2.0 tab

Creates REST service authentication credentials to connect to a REST service URL with the OAuth 2.0 protocol.

Figure: Configure Lookup > OAuth 2.0 tab

OAuth 2.0 tab

Fields

Field Name Definition

Token Type

Function:
Specifies the name of an external system, such as SharePoint, Google Drive, or Box from the list.
Accepted Values:
The name of an external system.
Default Value:
None

Token

Function:
Specifies the access token for the specified external system.
Accepted Values:
An access token from the list.
Default Value:
None.

When you select an external system from the Token Type field, the name of the access token for the specified system shows in this field.

Configure Lookup > Windows Authentication tab

Creates REST service authentication credentials to connect to a REST service URL with Windows Authentication (NTLM).

Figure: Configure Lookup > Windows Authentication tab

Windows Authentication tab

Prerequisites

Fields

Field Name Definition

Domain

Function:
The domain for the REST service authentication.
Accepted Values:
A valid domain.
Default Value:
None

User Name

Function:
Specifies the user name for the REST service authentication.
Accepted Values:
A valid user name.
Default Value:
None

Password

Function:
The password for the authentication account.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None
Example:
Refer to:

Configure Lookup > Request tab

Configures a lookup with the existing data format from your data source.

Figure: Configure Lookup > Request tab

Request tab

Fields

Field Name Definition

Request Payload

Function:
Specifies your payload values in the box. The values of the payload must be in JSON/XML format.
Accepted Values:
  • JSON
  • XML
Default Value:
The value specified in the XML/JSON Payload field of the access token.

Map Schema

Opens this Screen:
Schema Mapper screen
Function of this Screen:
Maps SharePoint fields, form fields, web methods, or other input sources to an XML schema..

Configure Lookup > Response tab

Connects the response data from the REST call to your app.

Figure: Configure Lookup > Response tab

Response tab

Fields

Field Name Definition

Store the Response in Form Field

Function:
Specifies the variable that contains the response to a method call. The method calls a REST service.

This field is applicable only for Multiple Columns lookup type.

Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Enter Sample Response

Function:
Specifies sample response schema to connect to your process.
Accepted Values:
  • Selected - Configures sample response schema to connect to your process.
  • Deselected - Configures a response schema with a simulation.
Default Value:
Selected

Header (Optional)

Function:
Specifies the custom headers for the REST service
Accepted Values:
  • Name - Specifies a name of the custom header.
  • Value - Specifies a value to use for the custom header.
Default Value:
None

Add New Record

Function:
Adds the row for Name and Value fields.
To Open this Field:
  1. On the Configure Lookup screen, in the Response tab, select Enter Sample Response.

Update

Function:
Updates the row with Name and Value fields.
To Open this Field:
  1. On the Configure Lookup screen, in the Response tab, click Add New Record.

Delete

Function:
Deletes the row with Name and Value fields.
To Open this Field:
  1. On the Configure Lookup screen, in the Response tab, click Update.

Edit

Function:
Changes the row with Name and Value fields.
To Open this Field:
  1. On the Configure Lookup screen, in the Response tab, click Update.

Sample JSON/XML

Function:
Specifies an example response payload to connect the process schema in JSON or XML format.
Accepted Values:
Sample payload data in XML or JSON format.
Default Value:
None

Payload

Function:
Specifies JSON or XML response payload to connect to the process schema.
Accepted Values:
  • XML
  • JSON
Default Value:
JSON

Simulate

Opens this Screen:
REST Response Configuration > Simulate
To Open this Field:
  1. On the Configure Lookup screen, in the Response tab, click Get Response from Simulation.
Function of this Screen:
Configures the response settings with a simulated REST method call.

Map Schema

Opens this Screen:
Schema Mapper screen
Function of this Screen:
Maps SharePoint fields, form fields, web methods, or other input sources to an XML schema..

Configure Lookup > Error Messages tab

Configures the message to show if the lookup does not return any data.

Figure: Configure Lookup > Error Messages tab

Error Messages tab

Fields

Field Name Definition

No Items Retrieved

Function:
Specifies the error message to show if the lookup does not return any data.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

Lookup Failed

Function:
Specifies the message to show if the data fails to load.
Accepted Values:
More than one line of text.
Default Value:
Failed to load data.