REST Query Stage
The REST Query pipeline stage is available in Fusion versions 3.0 and later.
|
|
In Fusion version 3.0 and earlier, this pipeline stage was called the Query RPC Stage. RPC is the acronym for Remote Procedure Calls.
|
The notation to send text as payload in Request entity (as string) field is <request.q>.
|
|
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.
|
Add results of a REST (RPC) call to the context, request or response.
skip - boolean
Set to true to skip this stage.
Default: false
label - string
A unique label for this stage.
<= 255 characters
condition - string
Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.
params - Call Parameters
uri - string
method - string
One of GET, POST, PUT, or DELETE
Allowed values: getputpostdelete
queryParams - Query parameters
headers - Request protocol headers
entity - string
debug - boolean
Setting to true will add a number of properties to either the context (in the Query case) or the document (in the indexing case)
Default: false
hasNoSideEffects - boolean
To run this stage in simulation mode, set to 'true'.
Default: false
mappingRules - array[object]
object attributes:{path required : {
display name: XPath Expression
type: string
}target required : {
display name: Target Key
type: string
}targetLocation : {
display name: Target Location
type: string
}append : {
display name: Append to Existing Values in Target Location. Only Valid when the Target Location is 'Request'
type: boolean
}xml : {
display name: Add as an XML Fragment
type: boolean
}}
resultsLocation - string
If As Response is chosen, then the result of the RPC call will be the one and only response. In all other cases, the stage will put the response from the REST/RPC call into the target location using the resultsKey.
Default: Request
Allowed values: RequestResponseContextAs Response
resultsKey - stringrequired
The name of the key to store the results object under. See the documentation for the type of objects stored.
Default: queryRPC
useIncomingRequestEntity - boolean
If an input entity is POSTed or PUT from the client, we can pass that along to the RPC target.
Default: false