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, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
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 variable registry only)
Record ReaderController Service API:
RecordReaderFactory
Implementations: Syslog5424Reader
AvroReader
JsonPathReader
ScriptedReader
XMLReader
GrokReader
JsonTreeReader
SyslogReader
CSVReader
The record reader to use for loading the payload and handling it as a record set.
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 ServiceController Service API:
SSLContextService
Implementations: StandardRestrictedSSLContextService
StandardSSLContextService
The SSL Context Service used to provide client certificate information for TLS/SSL connections.
Proxy 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: HTTP + AuthN, SOCKS
Basic Authentication 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 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 Authenticationfalse
  • true
  • false
Whether to communicate with the website using Digest Authentication. 'Basic Authentication Username' and 'Basic Authentication Password' are used for authentication.

Dynamic Properties:

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: false

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.