RestLookupService

Description:

Use a REST service to look up values.

Additional Details...

Tags:

rest, lookup, json, xml, http

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
URLrest-lookup-urlThe URL for the REST endpoint. Expression language is evaluated against the lookup key/value pairs, not flowfile attributes.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Record Readerrest-lookup-record-readerController Service API:
RecordReaderFactory
Implementations: CEFReader
Syslog5424Reader
ScriptedReader
SyslogReader
CSVReader
GrokReader
JsonTreeReader
XMLReader
AvroReader
ReaderLookup
WindowsEventLogReader
ParquetReader
JsonPathReader
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: true (will be evaluated using variable registry only)
SSL Context Servicerest-lookup-ssl-context-serviceController Service API:
SSLContextService
Implementations: StandardRestrictedSSLContextService
StandardSSLContextService
The SSL Context Service used to provide client certificate information for TLS/SSL connections.
Proxy Configuration Serviceproxy-configuration-serviceController Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: SOCKS, HTTP + AuthN 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: true (will be evaluated using variable registry only)
Basic Authentication Passwordrest-lookup-basic-auth-passwordThe password to be used by the client to authenticate against the Remote URL.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
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.
Connection Timeoutrest-lookup-connection-timeout5 secsMax wait time for connection to remote service.
Read Timeoutrest-lookup-read-timeout15 secsMax wait time for response from remote service.

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
**All dynamic properties are added as HTTP headers with the name as the header name and the value as the header value.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.