Configure Lookup for REST > Name/Value

Configures a lookup with name/value pairs from REST.

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.
  6. On the Lookup Details screen, select Name/Value.
  7. Click Next.

Advanced Configuration tab

Configures a lookup in details for the REST service.

Figure: 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 (Seconds)
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 (Seconds)
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:
  • Header Name
  • Header Value
Default Value:
None
Accepts Process Data Variables:
Yes

Add Header
Function:
Specifies the header name and value to add in the Header and Value field.

Authentication
Opens this Screen:

Advanced Configuration > Authentication screen > Basic Authentication tab

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

Figure: 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.

Advanced Configuration > Authentication screen > OAuth 2.0 tab

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

Figure: 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.

Advanced Configuration > Authentication screen > Windows Authentication tab

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

Figure: Windows Authentication tab

Windows Authentication tab

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:

Request tab

Configures the request payload for the REST service method call.

Figure: 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..

Response tab

Configures to connect response data from the web service call to your process.

Figure: Response tab

Response tab
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 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 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..

Error Messages tab

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

Figure: Error Messages tab

Error Messages tab

Fields

Field Name Definition

No Items Available
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

Failure Messages
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.