Use a REST service to look up values.
rest, lookup, json, xml, http
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 Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| URL | rest-lookup-url | The 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 Reader | rest-lookup-record-reader | Controller Service API: RecordReaderFactory Implementations: EBCDICRecordReader JsonTreeReader GrokReader ReaderLookup IPFIXReader WindowsEventLogReader ParquetReader CSVReader Syslog5424Reader JASN1Reader ExcelReader CiscoEmblemSyslogMessageReader ScriptedReader ProtobufReader JsonPathReader XMLReader CEFReader SyslogReader AvroReader YamlTreeReader | The record reader to use for loading the payload and handling it as a record set. | |
| Record Path | rest-lookup-record-path | An 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 Service | rest-lookup-ssl-context-service | Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService | The SSL Context Service used to provide client certificate information for TLS/SSL connections. | |
| Proxy Configuration Service | proxy-configuration-service | Controller 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 Username | rest-lookup-basic-auth-username | The 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 Password | rest-lookup-basic-auth-password | The 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 Authentication | rest-lookup-digest-auth | false |
| Whether to communicate with the website using Digest Authentication. 'Basic Authentication Username' and 'Basic Authentication Password' are used for authentication. |
| Connection Timeout | rest-lookup-connection-timeout | 5 secs | Max wait time for connection to remote service. | |
| Read Timeout | rest-lookup-read-timeout | 15 secs | Max wait time for response from remote service. |
Supports Sensitive Dynamic Properties: Yes
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| * | * | 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) |