Skip to main content

RestLookupService

Description​

Use a REST service to look up values.

Tags​

http, json, lookup, rest, xml

Properties​

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
URL *rest-lookup-urlThe URL for the REST endpoint. Expression language is evaluated against the lookup key/value pairs, not flowfile attributes.

Supports Expression Language, using FlowFile attributes and Environment variables.
Record Reader *rest-lookup-record-readerController Service:
RecordReaderFactory

Implementations:
AvroReader
CEFReader
CSVReader
ExcelReader
GrokReader
JsonPathReader
JsonTreeReader
ReaderLookup
ScriptedReader
Syslog5424Reader
SyslogReader
WindowsEventLogReader
XMLReader
YamlTreeReader		The record reader to use for loading the payload and handling it as a record set.
Record Pathrest-lookup-record-pathAn optional record path that can be used to define where in a record to get the real data to merge into the record set to be enriched. See documentation for examples of when this might be useful.

Supports Expression Language, using Environment variables.
Response Handling Strategy *rest-lookup-response-handling-strategyReturned
  • Returned
  • Evaluated
Whether to return all responses or throw errors for unsuccessful HTTP status codes.
SSL Context Servicerest-lookup-ssl-context-serviceController Service:
SSLContextService

Implementations:
StandardRestrictedSSLContextService
StandardSSLContextService		The SSL Context Service used to provide client certificate information for TLS/SSL connections.
Authentication Strategy *rest-lookup-authentication-strategyNone
  • None
  • Basic
  • OAuth2
Authentication strategy to use with REST service.
OAuth2 Access Token Provider *rest-lookup-oauth2-access-token-providerController Service:
OAuth2AccessTokenProvider

Implementations:
StandardOauth2AccessTokenProvider		Enables managed retrieval of OAuth2 Bearer Token applied to HTTP requests using the Authorization Header.

This property is only considered if:
  • the property Authentication Strategy has a value of OAUTH2
Proxy Configuration Serviceproxy-configuration-serviceController Service:
ProxyConfigurationService

Implementations:
StandardProxyConfigurationService		Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN, SOCKS In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor.
Basic Authentication Usernamerest-lookup-basic-auth-usernameThe username to be used by the client to authenticate against the Remote URL. Cannot include control characters (0-31), ':', or DEL (127).

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property Authentication Strategy has a value of BASIC
Basic Authentication Passwordrest-lookup-basic-auth-passwordThe password to be used by the client to authenticate against the Remote URL.

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property Authentication Strategy has a value of BASIC
Use Digest Authenticationrest-lookup-digest-authfalse
  • true
  • false
Whether to communicate with the website using Digest Authentication. 'Basic Authentication Username' and 'Basic Authentication Password' are used for authentication.

This property is only considered if:
  • the property Authentication Strategy has a value of BASIC
Connection Timeout *rest-lookup-connection-timeout5 secsMax wait time for connection to remote service.
Read Timeout *rest-lookup-read-timeout15 secsMax wait time for response from remote service.

State Management​

This component does not store state.

Restricted​

This component is not restricted.

System Resource Considerations​

This component does not specify system resource considerations.

See Also​